My STK mod, still WIP.
Go to file
auria 1dfd236705 Clarify license
git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@10937 178a84e3-b1eb-0310-8ba1-8eac791a3b58
2012-03-06 19:29:40 +00:00
cmake Apply another patch by riebl to move detection of Ogg/Vorbis to the find_package module in a subdir 2012-03-06 17:07:16 +00:00
contrib Applied SciYann's build system improvement. 2009-01-02 19:34:38 +00:00
data Refactored skidding to use a new base class SkiddingProperties. 2012-03-06 11:28:04 +00:00
doc Fixed old berlios link. 2011-10-18 20:52:14 +00:00
m4 Applied SciYann's build system improvement. 2009-01-02 19:34:38 +00:00
src Apply patch by riebl : fix possible crash when OpenAL was disabled 2012-03-06 16:33:06 +00:00
tools Don't install font-tool files. 2011-11-14 23:01:03 +00:00
acinclude.m4 More SVN property fixes. 2009-02-25 23:08:07 +00:00
AUTHORS More SVN property fixes. 2009-02-25 23:08:07 +00:00
autogen.sh - simplified autogen.sh to use autoreconf (instead of manually maintaining 2008-05-25 19:42:48 +00:00
ChangeLog Added rescue improvements. 2011-11-02 00:00:41 +00:00
CHANGES More SVN property fixes. 2009-02-25 23:08:07 +00:00
CMakeLists.txt Apply another patch by riebl to move detection of Ogg/Vorbis to the find_package module in a subdir 2012-03-06 17:07:16 +00:00
config.rpath Applied SciYann's build system improvement. 2009-01-02 19:34:38 +00:00
configure.ac Update mentionned irrlicht version in configure 2011-11-20 00:17:11 +00:00
COPYING Clean COPYING file 2011-02-27 21:43:13 +00:00
INSTALL Fixed outdated INSTALL file, just give a link to the wiki, that's what we keep up to date anyway 2011-07-30 15:59:16 +00:00
Makefile.am Fixed distribution of cmake files with autotools. 2011-11-14 22:29:15 +00:00
README Merge changes to README and TODO from branch to trunk 2011-04-04 15:19:50 +00:00
reconf.sh As suggested by Christoph Debian, don't use csh for shell in reconf 2010-11-05 17:37:00 +00:00
sources.cmake Fixed linux compilation problems, updated cmake project files. 2012-03-06 11:37:47 +00:00
SVN-CONFIG Updated svn config file recommendations to include 2011-07-28 02:02:49 +00:00
TODO Merge changes to README and TODO from branch to trunk 2011-04-04 15:19:50 +00:00
update_file_list.sh Apply a bunch of CMake patches by riebl, thanks\! 2012-03-06 00:18:51 +00:00

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).