Contents |
Stable Release 2.0
This is the English language documentation for Crystal Space and CEL.
This documentation is also found in the CS/docs/html directory of the 2.0 release packages.
| Crystal Space user manual | view online | download |
| Crystal Space public API reference | view online | download |
| Wiki Documentation | CS Wiki Documentation | |
|---|---|---|
| CEL user manual | view online | download |
| CEL public API reference | view online | download |
| Wiki documentation | CEL Wiki Documentation | |
| CEL Design document | CEL Design | |
| Tutorials | Tutorials | |
| FAQ | FAQ | |
Previous Stable Versions
Documentation for older stable releases is still available; follow the links below and browse around:
| Crystal Space | view online | download |
| CEL | view online | download |
Development Version (trunk)
This documentation is generated daily from the bleeding-edge SVN version of Crystal Space. You can find this documentation in the CS/docs/html directory of your local Crystal Space installation.
| Crystal Space user manual | view online | download |
| Crystal Space public API reference | view online | download |
| CEL user manual | view online | download |
| CEL public API reference | view online | download |
| CSEditing user manual | view online | download |
| CSEditing public API reference | view online | download |
It is possible for readers to add annotations to the online documentation. Useful and important annotations may be applied to the official documentation.
Other Documentation
Here are a few other documentation items.
- FAQ
- Tutorials
- The Community Site has a lot of tutorials and articles about Crystal Space. Recommended!
- Architecture Structure Summary for Crystal Space This is a high-level summary. Many plugins are not mentioned, such as sound, sequence manager, video format plugins, reporter, vfs, etc.
- Seminar slides about CS (PDF version, OpenOffice version)
- Once project: CEL Tutorial
- PlaneShift project: CEL Tutorial
- Game Programming Wiki seems to have a few unique but old resources.
- PyCrystal Entry point for the cs and cel python bindings.
- Eclipse tutorial Configure Eclipse to work with Crystal Space projects.
Old Documentation
- Maze Game Tutorial Contains a simple maze game in seven stages of development and includes explanation of what is happening in each stage. (download version). This tutorial is now part of the manual.
