stk-code_catmod

My STK mod, still WIP.

Go to file

Marianne Gagnon bc6be28f7d Add ignore file		2014-01-14 19:50:51 -05:00
cmake	On VS don't use a Source folder, which is just one	2013-11-15 22:45:14 +00:00
data	SSAO: Use a proper rand() function to generate fragment local coordinate system.	2014-01-14 14:22:01 +00:00
doc	Merge branch 'hilnius'	2013-12-05 17:28:55 +00:00
lib	OGL32CTX: Add vertex shader where default one was assumed.	2014-01-08 23:11:10 +00:00
src	Replaced boolstr with toString specialisation for bool;	2014-01-14 11:47:25 +00:00
tools	Remove some more useless autotools files	2013-12-16 23:21:37 +00:00
.gitignore	Add ignore file	2014-01-14 19:50:51 -05:00
AUTHORS	More SVN property fixes.	2009-02-25 23:08:07 +00:00
ChangeLog	Add 0.8.1 changelog	2013-11-15 00:13:32 +00:00
CHANGES	More SVN property fixes.	2009-02-25 23:08:07 +00:00
CMakeLists.txt	Remove definition of NDEBUG for VS (since VS will define this	2014-01-07 02:04:31 +00:00
COPYING	Remove obsolete license info from the COPYING file as per qubodup's forum suggestion	2012-06-26 21:14:06 +00:00
INSTALL	Uodated list of dependencies.	2013-12-31 09:30:41 +00:00
README	I updated the requirements to something a but more realistic	2013-12-26 19:42:11 +00:00
sources.cmake	Removed old network_http and related data structure. Its function	2014-01-13 05:21:48 +00:00
SVN-CONFIG	Minor update to svn config, to ignore blend1 and blend2 in media repo	2012-12-01 16:33:45 +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	CMake: mimic folder hierarchy with source_group for MSVC	2012-03-15 12:41:52 +00:00

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.
    NVIDIA GeForce 8xxx and higher
    ATI Radeon HD 4xxx and higher
    Intel HD 3000 and higher
* You should have a CPU that's running at 1GHz or better.
* You'll need at least 512 MB of free VRAM (video memory).
* Disk space: 400MB
* 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).