Top 10, a racing simulator
by Johann Deneux <johann.deneux@it.uu.se>

1. Introduction

Top10 is a go-kart racing simulation. It is far from complete, but it is
already playable and fun. It offers the following features:

* Hardware acceleration through OpenGL
* Stereo sounds
* Driving wheel and joysticks are supported. You can use the keyboard as well.
* Force feedback under Linux (broken right now, but it will be back ;)
* Runs on Linux and Windows
* Race against the clock (aka ghost mode)
* Wet weather.

2. Installing

2.1. Linux

2.1.1 Without force feedback

This program is targeted to both MS-Windows and Linux. The prefered OS (ie
the one for which the soft is most up to date) is Linux.
What you need in order to compile and run the game under Linux is:

* SDL 1.2
* SDL_image 1.2.0
* lib3ds 1.2.0
* OpenGL
* GLU
* gcc 3
* GNU make
* automake 1.7
* PLIB 1.8.3
* MAD for mp3 decoding (not yet used, but it's planned)

To compile, follow these steps below. The three first steps are only necessary
if ./configure does not exist (i.e: you downloaded the CVS source)
% aclocal -I .
% automake -a -c
% autoconf
% ./configure
% make
% make install


2.1.2 With force feedback

Well, force feedback is not working for now...

2.2. MS Windows

Basically, almost exactly the same thing as linux, provided you are using mingw.
You need to install all libraries mentioned in the linux section.

3. Running

I advise you to use a wheel, it's much more realistic.

Command-line options are:
-fs
 Use fullscreen mode.

-w <width>
-h <height>
 Size in pixel of the screen.

-ns
 No Sound.

-kf <kart file>
 Physical properties of the kart.

Keyboad commands are:
 <ESC> for hiding/showing the ugly menu
 <PageUp> and <PageDown> Switch camera
 <e> Accelerate
 <d> Brake
 <k> Turn left
 <l> Turn right

These mappings may appear weird, but their advantage is that they should work
as well with QWERTY keyboards as with AZERTY ones.

I hope you managed to sort out which options fit your needs !

4. Interesting things to know
Top10 creates a directory called .top10 (on linux) or top10 (windows) in 
in your home directory. Recordings of all your sessions are stored there. 
You may want to erase them every now and then, as they can eat up a large
amount of space after a while.

The background music will use data/sounds/music.mp3.

