Note: This documentation is under active development. If you are interested in helping out, get in touch.
The recommended way of using X3DOM in your application is downloading a released version to your local machine or server. The code of a released version should be usable in all modern browsers.
X3DOM itself depends on no external libraries. All you need in order to make it work are the following files:
|x3dom-v1.2.js||The minified X3DOM library in a given version|
|x3dom-v1.2.css||Stylesheets for X3DOM, you need to include this file in your webpage in order for X3DOM to display. However you can also take it as template to adapt your own stylesheet.|
|x3dom-1.2.swf||The Flash 11 integration, for browsers not supporting native X3DOM or WebGL.|
You can download the files from the X3DOM server and put them on your harddisk or your webserver. The file naming follows the pattern: x3dom-vMAIOR.MINOR.js.
If you are adventurous and want to work with the latest development build of X3DOM download the latest builds from the X3DOM server. Just use the files ending in no version number:
WARNING: Do NOT use the development builds in a production system. It is not thoroughly tested. It is not stable and will probably break things. If in doubt, use the current release.
Note: The following is for advanced developers. If you wish to use a rather recent version of X3DOM and do not want to tinker with Python, just use the development build.
All source code to X3DOM is kept under the Git revision control and you can browse the repository online. There is a download link available for any file or directory, if you only nee a portion of the X3DOM code.
If you have access to Git, you can get a copy of the repository here:
git clone https://github.com/x3dom/x3dom.git
You can also check out a specific release from GitHub:
git clone https://github.com/x3dom/x3dom.git git checkout <version> e.g. git checkout 1.2.0
If you want to build your own copy of X3DOM from the Git repository, you need to build it from the sources.
X3DOM currently requires the following components to be installed on your computer:
Once you have all prerequisites installed, you can build X3DOM:
python manage.py --build
The resulting build will be written to the dist/ directory.
Fore more detailed information on working with the source, please see the developer wiki.