Skip to content
Andreas Plesch edited this page Jan 6, 2022 · 45 revisions

Welcome to the x3dom developer wiki. On this wiki you will find important information about how to contribute to X3DOM. If you are a developer who wants to build something using X3DOM, the developer documentation is the right point to start. Alternatively, updated documentation generated from the master branch is also available.

The Documentation addendum wiki page fills in a few gaps in the main documentation site.

Contributing

If you would like to contribute to X3DOM, there are severals ways you can do this. First you should subscribe to the developers mailing list, where the developers of X3DOM discuss the development of the library itself.

Need help?

If you want to use X3DOM and seek help and exchange of knowledge, please use the x3dom-users mailing list or the forums. Beginner questions usually have been asked already and in many cases the mailinglist or forum archives provide quick answers to many questions.

If you decided to post to the mailing list or forum, please include as much info as possible and describe your problem and what you tried already succinctly. Also read How To Ask Questions in order to increase the likelihood of receiving an answer that actually helps you.

Mailing Lists

Users (if you are using X3DOM to build something)
https://lists.sourceforge.net/lists/listinfo/x3dom-users

Developers (discussion of X3DOM development itself)
https://lists.sourceforge.net/lists/listinfo/x3dom-developers

Forums

http://sourceforge.net/projects/x3dom/

Issue Tracker

https://github.com/x3dom/x3dom/issues

Please report issues and attach patches here. For general help and questions direct you inquiry to the x3dom-users mailing list or one of the forums.

Uploading Files to the Issue Tracker
The GitHub issue tracker does not allow to upload files. However, there's a service that helps you with sharing files: https://gist.github.com/ Just copy and paste your file contents there and then copy the Gist URL into the issues form.

It immensely helps us if you can provide a small test or live web page illustrating your problem. So, if you can post the URL of a jsfiddle/codepen/glitch etc. with your issue, the chances we will have a look at it increase.

Contributors guide

Note: This section will be part of the official docs in the future: http://x3dom.org/docs/latest/internals/index.html