Ecksdee
http://ecksdee.sourceforge.net/

By Amir Taaki <genjix@gmail.com>, Vincent Knecht <vknecht@club-internet.fr>
under the GPL license.

Contents
1. Introduction
2. Building and Installing
3. Usage
4. Issues
5. Contact


~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Introduction

- the Crystal Space 3D SDK (http://www.crystalspace3d.org/)
- the Crystal Entity Layer (http://cel.crystalspace3d.org/)
- and Crystal Core, a tech demo for CS (http://crystalcore.crystalspace3d.org/)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2. Building and installing

You can build the project on Unix, Msys/Mingw, and Cygwin using the Jam build
tool. Microsoft Visual-C++ users can build the project using the project files
in the ecksdee/msvc directory.

2.1 Dependencies

 * Required:

   - Python 2.4 or higher

   - ODE 0.6, 0.7 or SVN : http://www.ode.org/
     http://sourceforge.net/project/showfiles.php?group_id=24884
     On win32, it is provided by the cs-win32libs package from CS site.
     On Unix, you will need to either install it from your packaging system, or
     build it yourself.
     Note that 'opcode' support in ODE is required, and 'float' precision is
     preferable over 'double' since it's more performant.

 * Recommended:

   - Cg toolkit v1.4 or higher: http://www.nvidia.com/object/cg_toolkit.html
     On win32, it is provided by the cs-win32libs package from CS site.
     Note that Cg also supports non-nvidia graphics adapters.

2.2 Jam

 The build system is based upon Jam rather than 'make'.  If you do not yet have
 jam installed, then check your distribution for a Jam package or download the
 source and compile/install Jam yourself.  You can find the source here:

    ftp://ftp.perforce.com/pub/jam/

 You will need at least version 2.4.

 Note that if you build Crystal Space from source with a non-MSVC compiler,
 you will get an embedded/ehanced version of jam. You can use it to build
 Ecksdee.

2.2.1 Building (check INSTALL file for detailed instructions)

 0. Build and install ODE. Also install Cg toolkit if wanted.

 1. Build CS and CEL then set their respective CRYSTAL and CEL environment
    variables to point to their directory. See CS and CEL  manuals:
      - http://crystalspace3d.org/docs/online/manual/
      - http://cel.crystalspace3d.org/docs/online/manual/

 2. Go to the top-level directory in the Ecksdee project tree.

 3. Run "./configure", possibly with some options, if you wish.  You can see a
    list of available options by invoking configure with the "--help" option.
    Note that CS and CEL aren't really meant to be installed, so better avoid
    the --prefix option.

 4. Run "jam".

2.2.2 Installing (not supported yet)

 1. Build the project.
 2. Ensure that you have write permissions to the install directories. On Unix
    (GNU/Linux, MacOS/X, Darwin, BSD) this usually means that you need to be
    the 'root' user.
 3. Run "jam install".

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3. Usage

  == Controls are changeable in data/config/input.cfg ==

  * Joystick (if detected):
    - first axis is used for head/pitch.
    - first button : fire (if weapon is present in inventory)
    - second button: thruster
    - third button : turbo (limited number)
    - fourth button: afterburner (warning, it decreases your health)

  * The arrow keys control ship's heading and pitch.

  * The 'c' key fires the laser.

  * The 'x' key controls thruster (forward).

  * The 'space' key controls turbo thrust.

  * Hold 'ALT' while turning for slide mode.

  * The 'F1' key changes camera view.

  * The 'F2' key opens chat input field.

  * The 'F4' key dumps informations about ship position and status.

  * The 'F5' key teleports ship to last checked checkpoint.

  * The 'ESC' key goes back to start menu or exit.

  * The 'TAB' key displays CEL console.

  * The mouse is to be used in the menu screens.

  == Command line parameters and configuration parameters ==

  * The default map is settable as a configuration key-value pair in
    AppEcksdee.cfg or you personal Ecksdee.cfg file:

       Ecksdee.DefaultLevel = /xd/levels/tracks/Track1.zip

    Generally, /xd/levels/tracks/ is mapped to the data/levels/tracks/ dir.

  * You can specify screen resolution:

       $ python ecksdee.py -mode=800x600
       or set those key-value pairs in config file:
       Video.ScreenWidth = 800
       Video.ScreenHeight = 600

  * You can also request or disable fullscreen:

       $ python ecksdee.py -fs (or -nofs)
       or set this key-value pair in config file:
       Video.FullScreen = yes

  * To display frame rate, enable Crystal Space's bugplug plugin:

       $ python ecksdee.py -plugin=bugplug
       or add/uncomment this key-value pair in config file:
       System.Plugins.iBugPlug = crystalspace.utilities.bugplug

       Much more is doable with bugplug, check for example "Ctrl-d e" ;-)

  * To capture a movie, enable Crystal Space's movierecorder plugin:

       $ python ecksdee.py -plugin=movierecorder
       Then use the keys mentioned in the following config key-value pairs:
       MovieRecorder.Keys.Record = o
       MovieRecorder.Keys.Pause = l

       More settings in data/csconfig/movierecorder.cfg (binary build) or your
       $CRYSTAL/data/config/movierecorder.cfg if you built from sources.

       Warning! The movie is recorded as non-compressed nuppel video, so it
       quickly gets *really* big.
       To encode the movie in a compressed format, use for example:
       mencoder crystal000.nuv -o my_movie.avi -ovc lavc \
       -lavcopts vcodec=mpeg4:vbitrate=1600

       Sadly, the movierecorder doesn't capture billboards (HUD) nor sound.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4. Issues

  * Check the BUGS file.

  * Bug-Reports: http://sourceforge.net/tracker/?group_id=157040&atid=802200

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

5. Contact

  IRC: #ecksdee at freenode.net

  Forums: http://sourceforge.net/forum/?group_id=157040

  Suggestions, requests, and greeting cards should be send to
  genjix@gmail.com and vknecht@club-internet.fr
