Thank you for downloading the Crate Game Engine.
The Crate Game Engine is a completely free game engine for adventure style games. It is released under the LGPL license (see COPYING for more information).
The Crate Game Engine is primarily a library for designing games, but comes with some executables for launching scripted games.
EXECUTABLES
You will find two executables in this package. The first is crate the second is maze.
- crate
The source code for 'crate' is in the folder 'launcher', and it is installed in $PREFIX/bin after a 'make install'.
crate is made for launching game files that are in the XML format.
To launch a game type 'crate <filename>'
All example games reside in the folder 'examples/XML'
As an example you might, from this folder, type:
launcher/crate examples/xml/Maze.xml
2) maze
Maze is an example of what a hardcoded c++ might look like. It is a fully implemented game that uses the Crate Game Engine as a library. Maze resides in the folder: 'examples/hardcoded'
DOCUMENTATION
In the folder 'docs' three main files of interest.
- CrateGameEngine.doxy
CrateGameEngine.doxy is an input file for the doxygen (http://www.doxygen.org) document generation tool. Please see the documenation for doxygen for instructions. A nightly updated version is available at: http://emptycrate.com/CGEDoxygen/index.html
2) CrateGameEngine.dtd
CrateGameEngine.dtd is an XML dtd file use for validating a game XML input file. If you have the xmllint tool, you can validate the example XML game by typing:
xmllint examples/xml/Maze.xml --dtdvalid docs/CrateGameEngine.dtd
3) CrateGameEngine.xmi
CrateGameEngine.xmi exists for historical purposes. It is the original outlined design created with umbrello (http://uml.sourceforge.net)