ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated and combined windows build instructions into one

Browse Source 
paragraph of readme, and simplified old README (e.g. removed
instruction on how to play the game).


git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@4595 178a84e3-b1eb-0310-8ba1-8eac791a3b58
This commit is contained in:
hikerstk 2010-02-01 02:08:57 +00:00
parent 4ad225818d
commit a1762e9b8d
3 changed files with 16 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README
View File

@ -1,22 +1,22 @@
SuperTuxKart
==============
SuperTuxKart is a free kart racing game. It is focusing on fun and
not on realistic kart physics. The SuperTuxKart homepage can be found at:
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:
http://supertuxkart.sourceforge.net/forum
The official SuperTuxKart forum is at. If you need support,
this would be the best place to start.
A big "thank you" to Steve Baker for designing and implementing the
original TuxKart, and to the GotM team for their invaluable work.
See the data/CREDITS file for individual credits.
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.
@ -25,68 +25,18 @@ HARDWARE REQUIREMENTS
* A sound card would be nice - but it's not essential.
* Ideally, you want a joystick with at least 6 buttons.
PLAYING THE GAME
================
SuperTuxKart is a kart racing game. Basically you run around the track,
and give your best shot at reaching the goal before your opponents. The ?
boxes can help you, and collection coins can build up your power, so you can
grab more than one collectable! But avoid the bananas, since they might
give you a nasty surprise.
Controls can be configured from the game, here are the defaults mappings:
Player 1:
Steer : Left / Right arrow
Accelerate : Up arrow
Brake : Down arrow
Use item : Right control
Sharp Turn : Right shift
Rescue : Backspace
Nitro : - (minus key)
Look back : Right alt
Player 2:
Steer : A / D key
Accelerate : W key
Brake : S key
Use item : Left control
Sharp Turn : Left shift
Rescue : Q key
Nitro : Caps lock
Look back : Left alt
Player 3:
Steer : F / H key
Accelerate : T key
Brake : G key
Use item : N key
Sharp Turn : C key
Rescue : R key
Nitro : V key
Look back : N key
Player 4:
Steer : J / L key
Accelerate : I key
Brake : K key
Use item : . key
Sharp Turn : M key
Rescue : u key
Nitro : , key
Look back : / key
The Escape key pauses the game and shows the race menu.
SUPPORT
=======
The main webpage is at:
COMPILING ON WINDOWS
====================
A project file for Visual Studio 9 (e.g. the free 2008 express
edition) is included in the sources. 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.
http://supertuxkart.sourceforge.net
If you have any problems, please go to the official SuperTuxKart Forum at:
http://supertuxkart.sourceforge.net/forum
While compilation with cygwin is not officially supported,
this has been done (check with the forum for details).
LICENSE

26
README.cygwin
View File

@ -1,26 +0,0 @@
Some short instruction on how to compile supertuxkart with cygwin:
1) You have to use supertuxkart revision 593 or later (which you are
probably doing since you are reading this readme :) ).
2) Install freeglut
This is part of the cygwin packages, so just select this in
the cygwin setup program.
3) Install OpenAL
We have had some problems with this, so this might be the most difficult stage.
4) Unpack superuxkart and run ./configure and make.
That should be all.
Comments:
1) A -DNOMINMAX is added for cygwin compilations, since otherwise
min and max are #defined, causing problems with all std::min and
std::max constructs.
If you have any problems, please post on the mailing list - I am
not a regular windows user, so am probably not able to help you.
hiker

54
README.windows
View File

@ -1,54 +0,0 @@
NOTE
====
If you have downloaded the 0.4 version and it does not start, please
install the Microsoft Visual C++ redistributable package ('vcredist_x86.exe')
included in this directory.
If you don't hear any sound, you have to install OpenAL (see http://ww.openal.org).
Simply install the OpenAL redistributable ('oalinst.exe').
The release comes with a full installer, which includes these redistributables.
If you are downloading a source version and want to compile it yourself:
There are two documented ways to compile an executable for windows: using
cygwin, and using visual c++ (tested with the free Express version).
If you have any problems, please post on the mailing list, and we will
do our best to help you.
Cygwin
======
1) Install freeglut
This is part of the cygwin packages, so just select this in
the cygwin setup program.
2) Install OpenAL
We have had some problems with this in the past, so it might be tricky.
3) Unpack supertuxkart and run ./configure and make.
That should be all.
Comments:
1) A -DNOMINMAX is added for cygwin compilations, since otherwise
min and max are #defined, causing problems with all std::min and
std::max constructs. This is done automatically by the configure
script.
Visual C++ Express
==================
There are now project files included for building SuperTuxKart with
Visual C++ - have a look at the src/ide/vc8 folder.
Since version r793 SuperTuxKart compiles with Visual C++ Express,
version 8.0, since rev 1267 Visual C++ project files are included.
The main project file is .../src/ide/vc8/supertuxkart.vcproj,
and it includes a sub project for the bullet library. More details
can be found in .../src/ide/vc8/README.
You still have to install all dependencies.