1SPRING-DEDICATED(6) Games SPRING-DEDICATED(6)
2
6 spring-dedicated - An open source RTS game engine - Dedicated Server
7
9 spring-dedicated [-i|--isolation] [--isolation-dir PATH] [-C|--config
10 FILE] SCRIPT
11 spring-dedicated --list-config-vars
13 spring-dedicated [-h|--help]
15 spring-dedicated --sync-version
17 spring-dedicated [-V|--version]
19
21 Spring is a versatile 3D RTS game engine. Using extensively Lua for
22 scripting game-specific code to make nearly every aspect of the engine
23 customizable, from GUI, to unit AI, to pathfinding.
24 It is mainly designed around online multiplayer games but can also be
26 played in single-player mode against AIs.
27 This is the dedicated, GUI-less server for hosting multiplayer games.
29 You need to feed it a start script in order to have it host a game.
30 Start script are generated by lobby clients (SpringLobby) or
31 autho-hosts (Spads, Springie). This is the most leight-weight version
32 of the engine, which basically only redirects network traffic, while
33 spring-headless still runs a full blown simulation of the game.
34
36 -h, --help
37 Print the options help message and exit
38 -V, --version
40 Display program version and exit
41 --sync-version
43 Display program sync version (for online gaming) and exit
44 --nocolor
46 Disables colorized stdout
47 --quiet
49 Ignore unreccognized arguments
50 -i, --isolation
52 Limit the data-dir (games & maps) scanner to one directory (see
53 --isolation-dir and the SPRING_ISOLATED env var)
54 --isolation-dir::'PATH'
56 Specify the isolation-mode data-dir (see --isolation and the
57 SPRING_ISOLATED env var)
58 --write-dir::'PATH'
60 Specify the directory used for all saving.
61 -C, --config::'FILE'
63 Exclusive configuration file
64 --list-config-vars
66 Dump all default config vars in JSON-format to STDOUT
67 -g, --game::'GAME'
69 instantly start the GAME with a minimal setup. Requires --map to be
70 present, too. Sets the modoption minimalsetup = 1
71 -m, --map::'MAP'
73 Requires --game to be set, too. see --game
74
76 ~/.config/spring/
77 The default data-directory (see section DATA DIR).
79 ~/.config/spring/springsettings.cfg
81 Contains the users settings for the engine, for things like graphic and
83 sound.
84 /etc/spring/datadir
86 Contains the : separated paths to additional data-dirs (see section
88 DATA DIR).
89
91 SPRING_LOG_SECTIONS Selective functionality to change the verbosity
92 (separated by ,).
93 SPRING_WRITEDIR Define custom primary write DATA DIR. Place where
95 spring saves logs, settings, ...
96 SPRING_DATADIR Adds additional DATA DIRs Spring will search for files
98 (separated by :).
99 SPRING_ISOLATED If defined, Spring will stop searching files outside of
101 the binaries directory. If it is set to a valid directory path, it will
102 be used as the isolation directory. See the --isolation and the
103 --isolation-dir options.
104 SPRING_NOCOLOR Same as spring --nocolor.
106
108 Can either be a:
109 · Spring URL (spring://[username[:password]@]host[:port])
111 · start script (often named script.txt)
113 · replay file (*.sdf)
115 · save game (*.ssf)
117
119 An all-in-one-folder setup, which allows to run Spring without
120 installation. To do so all relevant files (binaries & basecontent) must
121 be in a single folder, esp. spring(.exe), libunitsync.so/unitsync.dll
122 and springsettings.cfg. Spring will then use the all-in-one-folder for
123 writing and won’t do so anywhere else on the system, but it may open
124 other files & directories for reading.
125
127 Not to confuse with Portable Mode, this mode disables all automatic
128 Data Dir scanning and limit reading & writing to a single folder. This
129 is very useful when games want to run separate from other Spring games.
130 Isolation mode can be enabled by placing an empty isolated.txt next to
131 the spring executable or by setting SPRING_ISOLATED env var.
132
134 Data directories are searched for content, and among other things, may
135 contain:
136 · config files
138 · logs
140 · games
142 · maps
144 · AIs
146 · cache
148 Sorted by priority the engine may use multiple data directories, but it
150 will use only the one with the highest priority as writable, to write
151 cache & log files to. The hierarchy the engine loads DATA DIRs in can
152 be grouped in 3 sections:
153 ┌─────────┬─────────────┬─────────────────┬─────────────────┬─────────────────┐
155 │priority │ section │ normal │ portable │ isolation │
156 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
157 │ │ │ │ │ │
158 │ high │ custom user │ directory │ directory │ directory │
159 │ │ write │ defined via │ defined via │ defined via │
160 │ │ │ --write-dir │ --write-dir │ --write-dir │
161 │ │ │ │ │ │
162 │ │ │ SPRING_WRITEDIR │ SPRING_WRITEDIR │ SPRING_WRITEDIR │
163 │ │ │ envvar │ envvar │ envvar │
164 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
165 │ │ │ │ │ │
166 │ │ automatic │ CONFIG_HOME │ INSTALL_DIR │ ISOLATION_DIR │
167 │ │ scanned │ │ │ │
168 │ │ │ ETC_DIRS │ CONFIG_HOME │ │
169 │ │ │ │ │ │
170 │ │ │ USR_SHARE │ ETC_DIRS │ │
171 │ │ │ │ │ │
172 │ │ │ │ USR_SHARE │ │
173 ├─────────┼─────────────┼─────────────────┼─────────────────┼─────────────────┤
174 │ │ │ │ │ │
175 │ low │ custom user │ SPRING_DATADIR │ SPRING_DATADIR │ SPRING_DATADIR │
176 │ │ read │ envvar │ envvar │ envvar │
177 │ │ │ │ │ │
178 │ │ │ SpringData │ SpringData │ SpringData │
179 │ │ │ configtag │ configtag │ configtag │
180 └─────────┴─────────────┴─────────────────┴─────────────────┴─────────────────┘
181 CONFIG_HOME
183 Config directories in user’s home.
184 *nix/MacOSX:
186 ${XDG_CONFIG_HOME-"~/.config"}/spring
187 ~/.spring
189 Windows:
191 C:/.../My Documents/My Games/Spring/
192 C:/.../My Documents/Spring/
194 C:/.../All Users/Applications/Spring/
196 INSTALL_DIR Location of spring-dedicated binary.
198 ETC_DIRS Additional : separated DATA DIRs defined in
200 /etc/spring/datadir.
201 USR_SHARE
203 *nix/MacOSX: /usr/.../share/spring & binary dir if is Data Dir
204 MacOSX: .../Spring.app/Contents/Resources/share/games/spring/base/
206 Windows: Install directory
208 ISOLATION_DIR
210 Mode A (--isolation): INSTALL_DIR
211 Mode B (--isolation-dir): supplied dir
213
215 Spring can load configurations from multiple files and merge them. So
216 similar to DATA DIRs there is one file where the engine writes to and
217 multiple read-only files.
218 It scans following directories for config files :
220 ┌──────────┬────────────────────────────────────────────────┐
222 │priority │ scanned directories │
223 ├──────────┼────────────────────────────────────────────────┤
224 │ │ │
225 │exclusive │ file defined via --config │
226 │ │ (when defined only this is │
227 │ │ loaded) │
228 ├──────────┼────────────────────────────────────────────────┤
229 │ │ │
230 │ high │ write DATA DIR │
231 ├──────────┼────────────────────────────────────────────────┤
232 │ │ │
233 │ │ (skipped in Isolated mode) │
234 │ │ │
235 │ │ *nix/MacOSX: ~/.springrc │
236 │ │ │
237 │ │ Windows: │
238 │ │ C:\Users\USER\AppData\Local\springsettings.cfg │
239 ├──────────┼────────────────────────────────────────────────┤
240 │ │ │
241 │ low │ all read DATA DIRs │
242 └──────────┴────────────────────────────────────────────────┘
243 (The one with highest priority will be used for writing.)
245 The filename of such config files can be as following:
247 ┌─────────┬─────────────────────────────────────┐
249 │priority │ filenames │
250 ├─────────┼─────────────────────────────────────┤
251 │ │ │
252 │ high │ springsettings-%Engine_Version%.cfg │
253 ├─────────┼─────────────────────────────────────┤
254 │ │ │
255 │ │ springsettings.cfg │
256 ├─────────┼─────────────────────────────────────┤
257 │ │ │
258 │ │ springrc-%Engine_Version% │
259 │ │ (*nix/MacOSX only) │
260 ├─────────┼─────────────────────────────────────┤
261 │ │ │
262 │ low │ springrc (*nix/MacOSX only) │
263 └─────────┴─────────────────────────────────────┘
264 (An example for a versioned config file is "springsettings-94.1.cfg".)
266
268 spring(6) spring-legacy(6) spring-headless(6)
269
271 More information about Spring can be found at link:
272 http://springrts.com
273
275 Spring was written by the Spring developers.
276 This manual page was written by Marco Amadori
278 <marco.amadori@gmail.com[1]>, for the Debian project (and may be used
279 by others).
280
282 1. marco.amadori@gmail.com
283 mailto:marco.amadori@gmail.com
284Spring package 01/18/2018 SPRING-DEDICATED(6)