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

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.

The game is still under development, so don't trust this README, most of the
info here is out of date.

2. Installing from source code

If you are installing from binaries (i.e. you downloaded a setup.exe, .rpm,
.deb, .tgz), you can skip this section and jump to section 3.

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
* Cal3d 0.10.0 (not yet used, but planned)
* OpenGL
* GLU
* gcc 3
* GNU make
* automake 1.7
* PLIB 1.8.3
* MAD for mp3 decoding (not yet used, but 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)
% ./autogen.sh
% ./configure
% make
% make install

If you also want to build the track editor, replace the second step by: 
./configure --enable-tracked

2.1.2 With force feedback

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

2.2. MS Windows

This procedure is not quite stabilized it. I built top10 using mingw, then
switched to MS Visual C++ .NET 2003.
Hints:
- if you use mingw, link all executables statically. Using DLLs won't quite work.
- if you use MS Visual C++, do not link against SDLmain.a, include the C file
from the SDL source into your project instead.
Good luck!

3. Running

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

Command-line options are:
-nofs
 Disable fullscreen mode.

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

-nosnd
 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
 <Pause/Break> go to free camera mode (you need to assign axes in the commands menu to use it)
 <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 !

5. Troubleshooting

Look at the program's output (available in stderr.txt and stdout.txt in <Top10 install path>
on windows), you may find useful information there.

