mirror

hikerstk 0cedab0b53 Updated the recommended irrlicht version (in case that only 1.7* is 13 years ago
contrib a0b3e358ed Applied SciYann's build system improvement. 16 years ago
data 7462c74837 Updated donation list. 13 years ago
doc 281b601ed3 Updated challenges graph 15 years ago
m4 a0b3e358ed Applied SciYann's build system improvement. 16 years ago
src 68ac5b6049 Updated version numbers to 0.7.2. 13 years ago
AUTHORS a015985b94 More SVN property fixes. 16 years ago
CHANGES a015985b94 More SVN property fixes. 16 years ago
COPYING b01bceeb4a Clean COPYING file 14 years ago
ChangeLog 25acd49f93 Added missing Beastie kart. 13 years ago
INSTALL 7672216f2d Change the url of the repository in INSTALL 15 years ago
Makefile.am 3e6c3a6c85 Removed files that had been deleted ages ago. 15 years ago
README 6f0d4ecfd8 Merge changes to README and TODO from branch to trunk 14 years ago
SVN-CONFIG debede2d70 Add "._*" to the suggested list of patterns to ignore. 14 years ago
TODO 6f0d4ecfd8 Merge changes to README and TODO from branch to trunk 14 years ago
acinclude.m4 a015985b94 More SVN property fixes. 16 years ago
autogen.sh 8dd4d52006 - simplified autogen.sh to use autoreconf (instead of manually maintaining 17 years ago
config.rpath a0b3e358ed Applied SciYann's build system improvement. 16 years ago
configure.ac 2d4580de0f Updated the recommended irrlicht version (in case that only 1.7* is 13 years ago
reconf.sh 0fe3a55cb4 As suggested by Christoph Debian, don't use csh for shell in reconf 14 years ago

README

SuperTuxKart
============
SuperTuxKart is a free kart racing game. It is focusing on fun and
not on realistic kart physics. Instruction can be found on the
in-game help page.

The SuperTuxKart homepage can be found at:

http://supertuxkart.sourceforge.net

The official SuperTuxKart forum is at. If you need support,
this would be the best place to start.

http://supertuxkart.sourceforge.net/forum

Hope you enjoy the game.
- The SuperTuxKart development team.


HARDWARE REQUIREMENTS
=====================
* You need a 3D graphics card that supports OpenGL or Mesa.
* You should have a CPU that's running at 450MHz or better.
* You'll need at least 600 MB of free RAM.
* Ideally, you want a joystick with at least 6 buttons.


COMPILING SuperTuxkart
======================

WINDOWS
-------
A project file for Visual Studio 9 (e.g. the free 2008 express
edition) is included in the sources in src/ide/vc9. A separate
dependency package is available on SuperTuxKart's sourceforge
page, which includes all necessary libraries, header files,
and dlls to compile and run the source code.

While compilation with cygwin is not officially supported,
this has been done (check with the forum for details).

MAC OSX
-------
The latest information about compilation on Mac are on our wiki:
http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX
The Xcode project file is in /src/ide/Xcode/, but it still
requires that all dependencies are installed as explained on the wiki.

UNIX
----
See INSTALL for details.


LICENSE
=======
This software is released under the GNU General Public License (GPL) which
can be found in the file 'LICENSE' in the same directory as this file.
Information about the licenses for artwork are contained in
data/licenses.


3D COORDINATES
==============
A reminder for those looking at the code and 3d models:

STK : X right, Y up, Z forwards
Blender: X right, Y forwards, Z up

The exporters perform the needed transform, so in Blender you just work
with XY plane as ground, and things will appear fine in STK (using XZ
as ground in the code, obviously).