ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
67af723087
stk-code_catmod/README.md

39 lines
2.3 KiB
Markdown
Raw Normal View History

Readme improvments * added space afer `#` headline * corrected file names of files I could find * linked to files However one thing I could not fix was this sentence: "Information about the licenses for artwork are contained in `data/licenses`." The mentioned file or dir does not exist (anymore) and I could not find any other file, which would fit there.
2015-11-03 17:16:53 -05:00
# SuperTuxKart
Replace travis with github action
2021-01-28 20:47:33 -05:00
[![Build Status](https://github.com/supertuxkart/stk-code/workflows/main/badge.svg?branch=master)](https://github.com/supertuxkart/stk-code/actions?query=workflow%3Amain)
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
[![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)
[![#supertuxkart on the freenode IRC network](https://img.shields.io/badge/freenode-%23supertuxkart-brightgreen.svg)](https://webchat.freenode.net/?channels=supertuxkart)
Add newline after travis-ci badge
2014-01-31 12:00:24 -05:00
tidy up README
2016-05-28 09:07:33 -04:00
SuperTuxKart 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.
Updated and combined windows build instructions into one 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
2010-01-31 21:08:57 -05:00
Clear separation between information for readers/players and contributors (#3860)
2019-05-04 10:39:53 -04:00
The 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).
Fixed incorrect and missing key bindings, fixed all URLs (which were still pointing to berlios), some minor text changes. git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/trunk/supertuxkart@1525 178a84e3-b1eb-0310-8ba1-8eac791a3b58
2008-02-18 23:01:03 -05:00
Add link to preview release binaries
2020-12-03 23:04:43 -05:00
Latest release binaries can be found [here](https://github.com/supertuxkart/stk-code/releases/latest), and preview release [here](https://github.com/supertuxkart/stk-code/releases/preview).
Add link to latest release binaries download
2019-08-08 21:14:55 -04:00
Readme improvments * added space afer `#` headline * corrected file names of files I could find * linked to files However one thing I could not fix was this sentence: "Information about the licenses for artwork are contained in `data/licenses`." The mentioned file or dir does not exist (anymore) and I could not find any other file, which would fit there.
2015-11-03 17:16:53 -05:00
## Hardware Requirements
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
To run SuperTuxKart, make sure that your computer's specifications are equal or higher than the following specifications:
Fix #4278
2020-05-01 23:08:18 -04:00
* 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
* You should have a dual-core CPU that's running at 1 GHz or faster.
I updated the requirements to something a but more realistic git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@14798 178a84e3-b1eb-0310-8ba1-8eac791a3b58
2013-12-26 14:42:11 -05:00
* You'll need at least 512 MB of free VRAM (video memory).
Fix #4278
2020-05-01 23:08:18 -04:00
* System memory: 1 GB
* Minimum disk space: 700 MB
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
* Ideally, you'll want a joystick with at least 6 buttons.
- moved trunk/ to trunk/supertuxkart git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/trunk/supertuxkart@1118 178a84e3-b1eb-0310-8ba1-8eac791a3b58
2007-05-27 12:01:53 -04:00
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
## License
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
The 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`.
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
Clear separation between information for readers/players and contributors (#3860)
2019-05-04 10:39:53 -04:00
---
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
## 3D coordinates
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
A reminder for those who are looking at the code and 3D models:
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
SuperTuxKart: X right, Y up, Z forwards
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
Blender: X right, Y forwards, Z up
Improved README.md's quality - April 17 2017 (#2839) * Massive README.md update Readme.md updated and cleaned up, a new section was added * More updates to README.md Updated README.md with another STK Winbuild method, some additonal changes - mostly to enrich and improve the language of the readme file. Windows_build.md is just a scratch pad for README.md's Windows sections. * more tweaks to the file more tweaks, old windows build method was removed because it is confusing. additional tweaks were added * More tweaks to the file Updated the file to correct issues that were found in supertuxkart/stk-code#2839 Disk space requirement was updated to be more correct. mention of libvpx-devel was temporarly removed. step 8 was revised slightly * quick mistake correction
2017-04-18 19:02:24 -04:00
The 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).
Proper building instructions in the readme
2016-08-22 19:51:27 -04:00
## Building from source
Move building instructions to separate file
2018-06-08 16:54:22 -04:00
Building instructions can be found in [`INSTALL.md`](/INSTALL.md)
Reference in New Issue Copy Permalink