                               +-----------+
                               | S L U N E |
                               +-----------+

*** What is Slune???

Slune is a 3D game! It includes racing, car-crashing, and lots of
action! In addition, a multiplayer mode is available (see below).

Slune relies on very original technical choices:
 * The game, the network engine and a part of the 3D engine are
   written in Python (whereas the other part of the 3D engine is
   in C),
 * The multiplayer mode is based on Peer-To-Peer, and not on
   client-server. No server is needed!



*** Help needed !

We espescially search for graphists and translators.

We also search people for porting Slune to other OS, and for
maintaining the windows version.

Any feedback is welcome!!! In particular, about the game difficulty,
and the multiplayer mode.



*** How to translate Slune ?

 * cd Slune-with-deps-XXX/slune # go into the Slune directory

 * ./localeextract $TRANSLATE_TO $TRANSLATE_FROM

where $TRANSLATE_TO is the language you want to translate to (e.g. nb)
and $TRANSLATE_FROM the language you want to translate from (defaults
to en and then fr).
The script will output some GNU GetText code. Add this code to file:

./locale/$TRANSLATE_TO/LC_MESSAGES/slune.po

(create the file if it does not exist yet).
Then, in this code, translate all text following "msgstr". Don't touch
"msgid"!



*** Requirement

 * Python 2.2.x (the latest is the best; tested on 2.2.2, 2.2.3 and
   2.3)

 * Linux (any architecture; other OS may be supported but have not
   been tested at all)

 * OpenGL (tested with Radeon DRI and NVidia dirvers; hardware
   acceleration is heavily advised, though not strictly required)

 * SDL

 * OpenAL (www.openal.org), PyOgg and PyVorbis (www.xiph.org) for
   sound support.

 * Cal3D (cal3d.sourceforge.net)
   
The Slune tarball comes with all other dependencies (including Soya3D).



*** Installation

See ./INSTALL.

You may get the following warning:

  warning: install: modules installed to '/usr/share/',
  which is not in Python's module search path (sys.path)
  -- you'll have to change the search path yourself

You can safely ignore the warning !

You can play without installing by running ./run_without_install;
you STILL need to do the build step !!!



*** How to launch Slune?

Just type "slune" on a console !

There's also a command line interface, see "slune --help" for more
information.



*** How to play?

Mouse position / cursor key : left / right to turn; top to go faster;
down to go slower

Left   click / Ctrl : long jump
Middle click / Shift: high jump
Right  click / Alt  : nitro

When jumping: Roll up-down / Ctrl-shift: look up / down (for
looping,...)

q, escape: quit



*** About multiplayer mode

WARNING: The network engine does NOT pass through firewalls!
To play with a firewall, you MUST let the Slune TCP port opened (by
default, 36079).

The multiplayer mode has only been tested with 2 players with 100MB
Ethernet.



*** Known bugs

 * Memory leak : If the game becomes slower and slower, just close it
   and restart it.
   The leak appears to be in Python 2.2(.2); there is no leak with
   Python 2.3b (beta release !).

 * Sound problems : OpenAL may not support your sound card (e.g.
   sound quality is poor, and you get some error printed on the
   console, about "native_blitbuffer: Assertion `0' failed" or "fcntl:
   Invalid argument"). Some people has obtained good result by forcing
   the use of esd. For that, edit ~/.openalrc, and write in it :
   
     (define devices '(esd))



*** Contacts and website

jiba@tuxfamily.org
blam@tuxfamily.org

oomadness.tuxfamily.org/en/slune/index.html
