.. _readme:
Writing3D is a set of tools designed to lower the barrier-of-entry (and speed
up development time) for producing VR games, literature, and artwork. Click
here <https://wphicks.github.io/Writing3D/>_ to view the complete
documentation website.
The easiest way to get started with Writing3D is to download a zipfile install from one of the following locations:
Linux <http://writing3d.xyz/downloads/w3dLinux/W3DZip-Linux.tar.gz>_Windows <http://writing3d.xyz/downloads/w3dWindows/W3DZip-Windows.zip>_Mac <http://writing3d.xyz/downloads/w3dMac/W3DZip-Mac.zip>_Note that this includes the old (non-FOSS, Java-based) cwapp editor and a copy of the appropriate version of Blender. Unzip the archive to any convenient location. You can then launch CWEditor.jar with Java to begin creating Writing3D projects.
.. Warning:: The first time you open CWEditor.jar, you may need to open the Run menu, select "Configure Paths" and then simply click "OK" to get CWEditor to recognize the Writing3D backend.
Samples
^^^^^^^
After installing, try opening up any xml file in the Writing3D/samples/xml_samples
directory from within CWEditor. If you then click "Desktop Preview" at the
bottom of the page, the sample should run. If it does not, please
contact <https://wphicks.github.io/Writing3D/#id1>_ us.
For Developers
^^^^^^^^^^^^^^
For developers or those who prefer to work from the command line, check out the
Developer's Guide <https://wphicks.github.io/Writing3D/developer_guide.html#developer-guide>_
for install information.
Writing3D is currently in a beta stage of development. All of its core features have been implemented except the new Python-based FOSS GUI.
The best ways to contact those involved with the Writing3D project are by
tweeting @whimsicalilk <https://twitter.com/intent/tweet?screen_name=whimsicalilk> or by logging an
issue on Github <https://github.com/wphicks/Writing3D/issues>.