• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

android/H03-May-2022-2,9452,306

cmake/H28-Aug-2020-715606

data/H03-May-2022-568,078489,498

doc/H03-May-2022-634605

lib/H03-May-2022-380,545263,493

src/H28-Aug-2020-266,222176,799

tools/H28-Aug-2020-4,0102,839

BrewfileH A D28-Aug-2020161 1211

CHANGELOG.mdH A D28-Aug-202028.1 KiB663600

COPYINGH A D28-Aug-202034.4 KiB261144

INSTALL.mdH A D28-Aug-202012.5 KiB301209

NETWORKING.mdH A D28-Aug-202023.3 KiB366264

README.mdH A D28-Aug-20202.2 KiB3925

sources.cmakeH A D28-Aug-2020484 76

README.md

1# SuperTuxKart
2[![Build Status](https://travis-ci.com/supertuxkart/stk-code.svg?branch=master)](https://travis-ci.com/supertuxkart/stk-code)
3[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/supertuxkart/stk-code?svg=true&branch=master)](https://ci.appveyor.com/project/supertuxkart/stk-code)
4[![#supertuxkart on the freenode IRC network](https://img.shields.io/badge/freenode-%23supertuxkart-brightgreen.svg)](https://webchat.freenode.net/?channels=supertuxkart)
5
6SuperTuxKart is a free kart racing game. It focuses on fun and not on realistic kart physics. Instructions can be found on the in-game help page.
7
8The SuperTuxKart homepage can be found at <https://supertuxkart.net/>. There is also our [FAQ](https://supertuxkart.net/FAQ) and information on how get in touch with the [community](https://supertuxkart.net/Community).
9
10Latest release binaries can be found [here](https://sourceforge.net/projects/supertuxkart/files/SuperTuxKart/1.0/).
11
12## Hardware Requirements
13To run SuperTuxKart, make sure that your computer's specifications are equal or higher than the following specifications:
14
15* A graphics card capable of 3D rendering - NVIDIA GeForce 470 GTX, AMD Radeon 6870 HD series card or Intel HD Graphics 4000 and newer. OpenGL >= 3.3
16* You should have a dual-core CPU that's running at 1 GHz or faster.
17* You'll need at least 512 MB of free VRAM (video memory).
18* System memory: 1 GB
19* Minimum disk space: 700 MB
20* Ideally, you'll want a joystick with at least 6 buttons.
21
22## License
23The software is released under the GNU General Public License (GPL) which can be found in the file [`COPYING`](/COPYING) in the same directory as this file. Information about the licenses for the artwork is contained in `data/licenses`.
24
25---
26
27## 3D coordinates
28A reminder for those who are looking at the code and 3D models:
29
30SuperTuxKart: X right, Y up, Z forwards
31
32Blender: X right, Y forwards, Z up
33
34The export utilities  perform the needed transformation, so in Blender you just work with the XY plane as ground, and things will appear fine in STK (using XZ as ground in the code, obviously).
35
36## Building from source
37
38Building instructions can be found in [`INSTALL.md`](/INSTALL.md)
39