1SPRING(6) Games SPRING(6)
2
6 spring - An open source RTS game engine - Default Engine
7
9 spring [-f|--fullscreen] [-w|--window] [-m|--minimise] [--safemode]
10 [-s|--server IP_OR_HOSTNAME] [-p|--projectiledump] [-t|--textureatlas]
11 [--benchmark TIME [--benchmarkstart TIME]] [-i|--isolation]
12 [--isolation-dir PATH] [-n|--name STRING] [-C|--config FILE] [SCRIPT]
13 spring --list-ai-interfaces
15 spring --list-skirmish-ais
17 spring --list-def-tags
19 spring --list-config-vars
21 spring [-h|--help]
23 spring --sync-version
25 spring [-V|--version]
27
29 Spring is a versatile 3D RTS game engine. Using extensively Lua for
30 scripting game-specific code to make nearly every aspect of the engine
31 customizable, from GUI, to unit AI, to pathfinding.
32 It is mainly designed around online multiplayer games but can also be
34 played in single-player mode against AIs.
35 The engine can run graphics and simulation in two separate threads,
37 depending on the game and engine settings. This will typically boost
38 the performance on multi-core systems.
39
41 -h, --help
42 Print the options help message and exit
43 -V, --version
45 Display program version and exit
46 --sync-version
48 Display program sync version (for online gaming) and exit
49 --nocolor
51 Disables colorized stdout
52 --quiet
54 Ignore unreccognized arguments
55 -f, --fullscreen
57 Run in fullscreen mode
58 -w, --window
60 Run in windowed mode
61 -b, --minimise
63 Start in background (minimised)
64 --safemode
66 Turns off many things that are known to cause problems (i.e. on
67 PC/Mac’s with lower-end graphic cards)
68 -s, --server::'IP_OR_HOSTNAME'
70 Run as a server on the given address
71 -t, --textureatlas
73 Dump each finalised textureatlas into textureatlasN.tga
74 --benchmark::'TIME'
76 Enable benchmark mode (writes a benchmark.data file). The given
77 number specifies the timespan to test.
78 --benchmarkstart::'TIME'
80 Benchmark start time in minutes.
81 -i, --isolation
83 Limit the data-dir (games & maps) scanner to one directory (see
84 --isolation-dir and the SPRING_ISOLATED env var)
85 --isolation-dir::'PATH'
87 Specify the isolation-mode data-dir (see --isolation and the
88 SPRING_ISOLATED env var)
89 --write-dir::'PATH'
91 Specify the directory used for all saving.
92 -n, --name::'NAME'
94 Set your player name
95 -C, --config::'FILE'
97 Exclusive configuration file
98 --list-ai-interfaces
100 Dump a list of available AI Interfaces to STDOUT
101 --list-skirmish-ais
103 Dump a list of available Skirmish AIs to STDOUT
104 --list-def-tags
106 Dump a list of available Definition Tags in JSON-format to STDOUT
107 --list-ceg-classes
109 Dump a list of available Projectile classes in JSON-format to
110 STDOUT
111 --list-config-vars
113 Dump all default config vars in JSON-format to STDOUT
114 -g, --game::'GAME'
116 instantly start the GAME with a minimal setup. Requires --map to be
117 present, too. Sets the modoption minimalsetup = 1
118 -m, --map::'MAP'
120 Requires --game to be set, too. see --game
121
123 ~/.config/spring/
124 The default data-directory (see section DATA DIR).
126 ~/.config/spring/springsettings.cfg
128 Contains the users settings for the engine, for things like graphic and
130 sound.
131 /etc/spring/datadir
133 Contains the : separated paths to additional data-dirs (see section
135 DATA DIR).
136
138 SPRING_LOG_SECTIONS Selective functionality to change the verbosity
139 (separated by ,).
140 SPRING_WRITEDIR Define custom primary write DATA DIR. Place where
142 spring saves logs, settings, ...
143 SPRING_DATADIR Adds additional DATA DIRs Spring will search for files
145 (separated by :).
146 SPRING_ISOLATED If defined, Spring will stop searching files outside of
148 the binaries directory. If it is set to a valid directory path, it will
149 be used as the isolation directory. See the --isolation and the
150 --isolation-dir options.
151 SPRING_NOCOLOR Same as spring --nocolor.
153
155 Can either be a:
156 · Spring URL (spring://[username[:password]@]host[:port])
158 · start script (often named script.txt)
160 · replay file (*.sdf)
162 · save game (*.ssf)
164
166 An all-in-one-folder setup, which allows to run Spring without
167 installation. To do so all relevant files (binaries & basecontent) must
168 be in a single folder, esp. spring(.exe), libunitsync.so/unitsync.dll
169 and springsettings.cfg. Spring will then use the all-in-one-folder for
170 writing and won’t do so anywhere else on the system, but it may open
171 other files & directories for reading.
172
174 Not to confuse with Portable Mode, this mode disables all automatic
175 Data Dir scanning and limit reading & writing to a single folder. This
176 is very useful when games want to run separate from other Spring games.
177 Isolation mode can be enabled by placing an empty isolated.txt next to
178 the spring executable or by setting SPRING_ISOLATED env var.
179
181 Data directories are searched for content, and among other things, may
182 contain:
183 · config files
185 · logs
187 · games
189 · maps
191 · AIs
193 · cache
195 Sorted by priority the engine may use multiple data directories, but it
197 will use only the one with the highest priority as writable, to write
198 cache & log files to. The hierarchy the engine loads DATA DIRs in can
199 be grouped in 3 sections:
200 ┌─────────┬─────────────┬─────────────────┬─────────────────┬─────────────────┐
202 │priority │ section │ normal │ portable │ isolation │
203 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
204 │ │ │ │ │ │
205 │ high │ custom user │ directory │ directory │ directory │
206 │ │ write │ defined via │ defined via │ defined via │
207 │ │ │ --write-dir │ --write-dir │ --write-dir │
208 │ │ │ │ │ │
209 │ │ │ SPRING_WRITEDIR │ SPRING_WRITEDIR │ SPRING_WRITEDIR │
210 │ │ │ envvar │ envvar │ envvar │
211 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
212 │ │ │ │ │ │
213 │ │ automatic │ CONFIG_HOME │ INSTALL_DIR │ ISOLATION_DIR │
214 │ │ scanned │ │ │ │
215 │ │ │ ETC_DIRS │ CONFIG_HOME │ │
216 │ │ │ │ │ │
217 │ │ │ USR_SHARE │ ETC_DIRS │ │
218 │ │ │ │ │ │
219 │ │ │ │ USR_SHARE │ │
220 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
221 │ │ │ │ │ │
222 │ low │ custom user │ SPRING_DATADIR │ SPRING_DATADIR │ SPRING_DATADIR │
223 │ │ read │ envvar │ envvar │ envvar │
224 │ │ │ │ │ │
225 │ │ │ SpringData │ SpringData │ SpringData │
226 │ │ │ configtag │ configtag │ configtag │
227 └─────────┴─────────────┴─────────────────┴─────────────────┴─────────────────┘
228 CONFIG_HOME
230 Config directories in user’s home.
231 *nix/MacOSX:
233 ${XDG_CONFIG_HOME-"~/.config"}/spring
234 ~/.spring
236 Windows:
238 C:/.../My Documents/My Games/Spring/
239 C:/.../My Documents/Spring/
241 C:/.../All Users/Applications/Spring/
243 INSTALL_DIR Location of spring binary.
245 ETC_DIRS Additional : separated DATA DIRs defined in
247 /etc/spring/datadir.
248 USR_SHARE
250 *nix/MacOSX: /usr/.../share/spring & binary dir if is Data Dir
251 MacOSX: .../Spring.app/Contents/Resources/share/games/spring/base/
253 Windows: Install directory
255 ISOLATION_DIR
257 Mode A (--isolation): INSTALL_DIR
258 Mode B (--isolation-dir): supplied dir
260
262 Spring can load configurations from multiple files and merge them. So
263 similar to DATA DIRs there is one file where the engine writes to and
264 multiple read-only files.
265 It scans following directories for config files :
267 ┌──────────┬────────────────────────────────────────────────┐
269 │priority │ scanned directories │
270 ├──────────┼────────────────────────────────────────────────┤
271 │ │ │
272 │exclusive │ file defined via --config │
273 │ │ (when defined only this is │
274 │ │ loaded) │
275 ├──────────┼────────────────────────────────────────────────┤
276 │ │ │
277 │ high │ write DATA DIR │
278 ├──────────┼────────────────────────────────────────────────┤
279 │ │ │
280 │ │ (skipped in Isolated mode) │
281 │ │ │
282 │ │ *nix/MacOSX: ~/.springrc │
283 │ │ │
284 │ │ Windows: │
285 │ │ C:\Users\USER\AppData\Local\springsettings.cfg │
286 ├──────────┼────────────────────────────────────────────────┤
287 │ │ │
288 │ low │ all read DATA DIRs │
289 └──────────┴────────────────────────────────────────────────┘
290 (The one with highest priority will be used for writing.)
292 The filename of such config files can be as following:
294 ┌─────────┬─────────────────────────────────────┐
296 │priority │ filenames │
297 ├─────────┼─────────────────────────────────────┤
298 │ │ │
299 │ high │ springsettings-%Engine_Version%.cfg │
300 ├─────────┼─────────────────────────────────────┤
301 │ │ │
302 │ │ springsettings.cfg │
303 ├─────────┼─────────────────────────────────────┤
304 │ │ │
305 │ │ springrc-%Engine_Version% │
306 │ │ (*nix/MacOSX only) │
307 ├─────────┼─────────────────────────────────────┤
308 │ │ │
309 │ low │ springrc (*nix/MacOSX only) │
310 └─────────┴─────────────────────────────────────┘
311 (An example for a versioned config file is "springsettings-94.1.cfg".)
313
315 spring-legacy(6) spring-headless(6) spring-dedicated(6)
316
318 More information about Spring can be found at link:
319 http://springrts.com
320
322 Spring was written by the Spring developers.
323 This manual page was written by Marco Amadori
325 <marco.amadori@gmail.com[1]>, for the Debian project (and may be used
326 by others).
327
329 1. marco.amadori@gmail.com
330 mailto:marco.amadori@gmail.com
331Spring package 01/18/2018 SPRING(6)