You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To build the in-game recorder for STK, you have to install
79
87
`libopenglrecorder` from your distribution, or compile it yourself from [here](https://github.com/Benau/libopenglrecorder).
80
88
Compilation instruction is explained there. If you don't need this feature, pass `-DBUILD_RECORDER=off` to CMake.
81
89
82
-
### Shaderc for Vulkan support
90
+
#### Shaderc for Vulkan support
83
91
84
92
You need to compile [Shaderc](https://github.com/google/shaderc) forVulkan supportin SuperTuxKart if you are not building for Windows or macOS. If you don't need this feature, pass `-DNO_SHADERC=on` to CMake.
85
93
86
94
### Compiling
87
95
88
-
To compile SuperTuxKart, run the following commands inside the `stk-code` directory
96
+
To compile SuperTuxKart, run the following commands inside the `stk-code` directory:
89
97
90
98
```bash
91
99
# go into the stk-code directory
@@ -102,7 +110,7 @@ cmake ..
102
110
make -j$(nproc)
103
111
```
104
112
105
-
STK can then be run from the build directory with `bin/supertuxkart`
113
+
STK can then be run from the build directory with `bin/supertuxkart`.
106
114
107
115
#### Keeping your build up to date
108
116
@@ -115,11 +123,11 @@ cmake ..
115
123
make -j$(nproc)
116
124
```
117
125
118
-
##### Build Speed Optimization
126
+
#### Build Speed Optimization
119
127
120
-
"-j$(nproc)" is an example, for a faster build, use "-jx" instead, where "x" is the amount of CPU threads you have, minus one.
128
+
The `-j$(nproc)` option is an example. For a faster build, use `-jx` instead, where "x" is the amount of CPU threads you have, minus one.
121
129
122
-
### Further options
130
+
#### Further options
123
131
124
132
To create a debug version of STK, run:
125
133
@@ -134,21 +142,21 @@ sudo make install
134
142
```
135
143
136
144
The default install location is `/usr/local`, i.e. the data files will
137
-
be written to `/usr/local/share/games/supertuxkart`, the executable
145
+
be written to `/usr/local/share/games/supertuxkart` and the executable
138
146
will be copied to `/usr/local/bin`. To change the default installation
139
147
location, specify `CMAKE_INSTALL_PREFIX` when running CMake, e.g.:
140
-
`cmake .. -DCMAKE_INSTALL_PREFIX=/opt/stk`
148
+
`cmake .. -DCMAKE_INSTALL_PREFIX=/opt/stk`.
141
149
142
150
## Building SuperTuxKart on Windows
143
151
144
-
To Build SuperTuxKart on Windows follow these instructions:
152
+
To Build SuperTuxKart on Windows, follow these instructions:
145
153
146
154
1. Download and install Visual Studio from here: [Visual Studio - Download](https://www.visualstudio.com/downloads/). The free Visual Studio Community edition works fine. Remember to select "Desktop development with C++" in the installer.
147
155
148
-
2. If you want the stable version, download the SuperTuxKart source package from the latest stable version [SuperTuxKart on GitHub](https://github.com/supertuxkart/stk-code/releases) and unpack it.
156
+
2. If you want the stable version, download the SuperTuxKart source package from the latest stable version of [SuperTuxKart on GitHub](https://github.com/supertuxkart/stk-code/releases) and unpack it.
149
157
150
158
3. If you want the development version, you will need a Git client and an SVN client. More information can be found here: [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control).
151
-
Open your file browser and find somewhere you want to put the development version of SuperTuxKart. For example in C:\Users\<Your Username> as the Git and SVN clients will have write permissions there, and you should create its own directory, for example SuperTuxKart-dev. Enter that directory, and create a directory inside called stk-assets, and enter it. If you installed TortoiseSVN, right-click, select TortoiseSVN -> Checkout... and paste the corresponding URL found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). While it is downloading the game assets, go back to your file browser and one level up. Right-click again somewhere empty and select "Git clone..." and paste the corresponding link found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control).
159
+
Open your file browser and find somewhere you want to put the development version of SuperTuxKart. For example in C:\\Users\\\<Your Username\> as the Git and SVN clients will have write permissions there, and you should create its own directory, for example "SuperTuxKart-dev". Enter that directory, and create a directory inside called "stk-assets", and enter it. If you installed TortoiseSVN, right-click, select TortoiseSVN -> Checkout... and paste the corresponding URL found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control). While it is downloading the game assets, go back to your file browser and move one level up (if you followed the example that directory would be named "SuperTuxKart-dev"). Right-click again somewhere empty and select "Git clone..." and paste the corresponding link found in [SuperTuxKart.net - Source Control](https://supertuxkart.net/Source_control).
152
160
*Note: Both `stk-code` and `stk-assets` **must** be in the same directory, otherwise the build will likely fail!*
153
161
154
162
4. If you got the stable version, download the Windows dependencies package from [SuperTuxKart on GitHub - Dependencies Releases](https://github.com/supertuxkart/dependencies/releases), find the stk-code version there and download the `dependencies(arch).zip` as needed and unpack the archive into the `stk-code` directory.
@@ -204,7 +212,7 @@ and unpack the archive into the `stk-code` directory. Download `i686` if you use
204
212
msbuild.exe SuperTuxKart.sln
205
213
```
206
214
207
-
SuperTuxKart can now be run as `bin\Debug\supertuxkart.exe` or `bin\Release\supertuxkart.exe`
215
+
SuperTuxKart can now be run as `bin\Debug\supertuxkart.exe` or `bin\Release\supertuxkart.exe`.
208
216
209
217
## Building SuperTuxKart on Windows using LLVM MinGW
210
218
@@ -250,7 +258,7 @@ Install the developer tools, either from the OS X Install DVD or from Apple's we
250
258
251
259
Download `dependencies-macosx.tar.xz` from the `Assets` section [here](https://github.com/supertuxkart/dependencies/releases) and extract it inside the `stk-code` directory, use the `preview` version for git stk-code.
252
260
253
-
Build STK
261
+
Build STK:
254
262
255
263
```bash
256
264
cd /path/to/stk-code
@@ -270,6 +278,6 @@ By default, the executable that is produced is not ready for distribution. Insta
0 commit comments