Home - Forums - Documentation - Gallery - Bugs
(40 intermediate revisions not shown.)
Line 1: Line 1:
-
= Stable Release 1.0rc1 =
+
= Stable Release 2.0 =
-
This is the English language documentation for Crystal Space. This documentation is also found in the CS/docs/html directory of the 1.0rc1 release package.
+
This is the English language documentation for Crystal Space and CEL.<br/>
-
* User's manual: [http://www.crystalspace3d.org/docs/online/manual-1.0/ view online], [http://www.crystalspace3d.org/docs/download/manual-1.0/ download]
+
This documentation is also found in the CS/docs/html directory of the 2.0 release packages.
-
* Public API reference: [http://www.crystalspace3d.org/docs/online/api-1.0/ view online], [http://www.crystalspace3d.org/docs/download/api-1.0/ download]
+
-
Documentation for CEL:
+
{| border="1" cellpadding="5" cellspacing="0"
-
* User manual: [http://cel.crystalspace3d.org/docs/online/manual-1.0/ view online] or [http://cel.crystalspace3d.org/docs/download/manual-1.0/ download]
+
| Crystal Space user manual
-
* Public API reference: [http://cel.crystalspace3d.org/docs/online/api-1.0/ view online] or [http://cel.crystalspace3d.org/docs/download/api-1.0/ download]
+
| [http://www.crystalspace3d.org/docs/online/manual-2.0/ view online]
-
* Design document: [[CEL Design]]
+
| [http://www.crystalspace3d.org/docs/download/manual-2.0/ download]
 +
|-
 +
| Crystal Space public API reference
 +
| [http://www.crystalspace3d.org/docs/online/api-2.0/ view online]
 +
| [http://www.crystalspace3d.org/docs/download/api-2.0/ download]
 +
|-
 +
| Wiki Documentation
 +
!colspan="2"| [[CS Wiki Documentation]]
 +
|-
 +
{{CELDocsInTable_beta}}
 +
|-
 +
| Tutorials
 +
!colspan="2"| [[Tutorials]]
 +
|-
 +
| FAQ
 +
!colspan="2"| [[FAQ]]
 +
|}
-
= Development Version 1.1 =
+
= Previous Stable Versions =
 +
 
 +
Documentation for older stable releases is still available; follow the links below and browse around:
 +
 
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
| Crystal Space
 +
| [http://www.crystalspace3d.org/docs/online/ view online]
 +
| [http://www.crystalspace3d.org/docs/download/ download]
 +
|-
 +
| CEL
 +
| [http://crystalspace3d.org/cel/docs/online/ view online]
 +
| [http://crystalspace3d.org/cel/docs/download/ 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.
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.
-
* User's manual: [http://crystalspace3d.org/docs/online/manual/ view online], [http://crystalspace3d.org/docs/download/manual/ download]
 
-
* Public API reference: [http://crystalspace3d.org/docs/online/api/ view online], [http://crystalspace3d.org/docs/download/api/ download]
 
-
Documentation for CEL:
+
{| border="1" cellpadding="5" cellspacing="0"
-
* User manual: [http://cel.crystalspace3d.org/docs/online/manual/ view online] or [http://cel.crystalspace3d.org/docs/download/manual/ download]
+
| Crystal Space user manual
-
* Public API reference: [http://cel.crystalspace3d.org/docs/online/api/ view online] or [http://cel.crystalspace3d.org/docs/download/api/ download]
+
| [http://www.crystalspace3d.org/docs/online/manual/ view online]
-
* Design document: [[CEL Design]]
+
| [http://www.crystalspace3d.org/docs/download/manual/ download]
 +
|-
 +
| Crystal Space public API reference
 +
| [http://www.crystalspace3d.org/docs/online/api/ view online]
 +
| [http://www.crystalspace3d.org/docs/download/api/ download]
 +
|-
 +
| CEL user manual
 +
| [http://crystalspace3d.org/cel/docs/online/manual/ view online]
 +
| [http://crystalspace3d.org/cel/docs/download/manual/ download]
 +
|-
 +
| CEL public API reference
 +
| [http://crystalspace3d.org/cel/docs/online/api/ view online]
 +
| [http://crystalspace3d.org/cel/docs/download/api/ download]
 +
|-
 +
| CSEditing user manual
 +
| [http://crystalspace3d.org/csediting/docs/online/manual/ view online]
 +
| [http://crystalspace3d.org/csediting/docs/download/manual/ download]
 +
|-
 +
| CSEditing public API reference
 +
| [http://crystalspace3d.org/csediting/docs/online/api/ view online]
 +
| [http://crystalspace3d.org/csediting/docs/download/api/ download]
 +
|}
It is possible for readers to add annotations to the online documentation. Useful and important annotations may be applied to the official documentation.
It is possible for readers to add annotations to the online documentation. Useful and important annotations may be applied to the official documentation.
 +
<!--
= Translations =
= Translations =
Line 28: Line 77:
* [http://crystaldoc.sourceforge.net/ General translation project] (crystaldoc)
* [http://crystaldoc.sourceforge.net/ General translation project] (crystaldoc)
* [http://cs-doc-ja.sourceforge.jp/ Japanese translation project]
* [http://cs-doc-ja.sourceforge.jp/ Japanese translation project]
 +
-->
= Other Documentation =
= Other Documentation =
Here are a few other documentation items.
Here are a few other documentation items.
 +
* [[FAQ]]
 +
* [[Tutorials]]
* The [http://community.crystalspace3d.org/ Community Site] has a lot of tutorials and articles about Crystal Space. Recommended!
* The [http://community.crystalspace3d.org/ Community Site] has a lot of tutorials and articles about Crystal Space. Recommended!
* [http://www.crystalspace3d.org/img/structure_graph.jpg 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.
* [http://www.crystalspace3d.org/img/structure_graph.jpg 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.
Line 37: Line 89:
* [http://www.once.net.nz/ Once] project: [http://www.once.net.nz/wiki/moin.cgi/DevelopersFAQ?action=show CEL Tutorial]
* [http://www.once.net.nz/ Once] project: [http://www.once.net.nz/wiki/moin.cgi/DevelopersFAQ?action=show CEL Tutorial]
* [http://www.planeshift.it/ PlaneShift] project: [http://planeshift.sourceforge.net/celtut/cel.html CEL Tutorial]
* [http://www.planeshift.it/ PlaneShift] project: [http://planeshift.sourceforge.net/celtut/cel.html CEL Tutorial]
 +
* [http://gpwiki.org/index.php/Crystal_Space 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 =
= Old Documentation =
-
* [http://www.crystalspace3d.org/mazetut/mazetut_tutorial.html Maze Game Tutorial] Contains a simple maze game in seven stages of development and includes explanation of what is happening in each stage. ([ftp://sunsite.dk/projects/crystal/mazetut.zip download version]). This tutorial is now part of the manual.
+
* [http://{{CSSITE}}/mazetut/mazetut_tutorial.html Maze Game Tutorial] Contains a simple maze game in seven stages of development and includes explanation of what is happening in each stage. ([ftp://sunsite.dk/projects/crystal/mazetut.zip download version]). This tutorial is now part of the manual.
-
* CEL Tutorial: [/celtutorial.zip complete archive with document and all sources] or [/CelTutorial.pdf only the PDF with the explanation about the tutorial]. This tutorial is known to work correctly with Crystal Space and CEL from 22 June 2005. An updated version is part of the CEL manual now so this download is only useful for the blender sources of the artwork.
+
<!--
 +
* CEL Tutorial: [http://{{CSSITE}}/downloads/celtutorial.zip complete archive with document and all sources] or [http://{{CSSITE}}/downloads/CelTutorial.pdf only the PDF with the explanation about the tutorial]. This tutorial is known to work correctly with Crystal Space and CEL from 22 June 2005. An updated version is part of the CEL manual now so this download is only useful for the blender sources of the artwork.
 +
-->

Revision as of 15:46, 22 March 2013

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.

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.
| Article | Discussion | View source | History |