SPRING-LEGACY(6) | Games | SPRING-LEGACY(6) |
NAME¶
spring-legacy - An open source RTS game engine - Legacy Engine
SYNOPSIS¶
spring-legacy [-f|--fullscreen] [-w|--window] [-m|--minimise] [--safemode] [-s|--server IP_OR_HOSTNAME] [-p|--projectiledump] [-t|--textureatlas] [--benchmark TIME [--benchmarkstart TIME]] [-i|--isolation] [--isolation-dir PATH] [-n|--name STRING] [-C|--config FILE] [SCRIPT]
spring-legacy --list-ai-interfaces
spring-legacy --list-skirmish-ais
spring-legacy --list-def-tags
spring-legacy --list-config-vars
spring-legacy [-h|--help]
spring-legacy --sync-version
spring-legacy [-V|--version]
DESCRIPTION¶
Spring is a versatile 3D RTS game engine. Using extensively Lua for scripting game-specific code to make nearly every aspect of the engine customizable, from GUI, to unit AI, to pathfinding.
It is mainly designed around online multiplayer games but can also be played in single-player mode against AIs.
This engine version runs graphics and simulation in a single thread, and may marginally increase the performance on single-core systems.
OPTIONS¶
-h, --help
-V, --version
--sync-version
--nocolor
--quiet
-f, --fullscreen
-w, --window
-b, --minimise
--safemode
-s, --server::'IP_OR_HOSTNAME'
-t, --textureatlas
--benchmark::'TIME'
--benchmarkstart::'TIME'
-i, --isolation
--isolation-dir::'PATH'
--write-dir::'PATH'
-n, --name::'NAME'
-C, --config::'FILE'
--list-ai-interfaces
--list-skirmish-ais
--list-def-tags
--list-ceg-classes
--list-config-vars
-g, --game::'GAME'
-m, --map::'MAP'
FILES¶
~/.config/spring/
The default data-directory (see section DATA DIR).
~/.config/spring/springsettings.cfg
Contains the users settings for the engine, for things like graphic and sound.
/etc/spring/datadir
Contains the : separated paths to additional data-dirs (see section DATA DIR).
ENVIROMENT VARIABLES¶
SPRING_LOG_SECTIONS Selective functionality to change the verbosity (separated by ,).
SPRING_WRITEDIR Define custom primary write DATA DIR. Place where spring saves logs, settings, ...
SPRING_DATADIR Adds additional DATA DIRs Spring will search for files (separated by :).
SPRING_ISOLATED If defined, Spring will stop searching files outside of the binaries directory. If it is set to a valid directory path, it will be used as the isolation directory. See the --isolation and the --isolation-dir options.
SPRING_NOCOLOR Same as spring --nocolor.
SCRIPT¶
Can either be a:
PORTABLE MODE¶
An all-in-one-folder setup, which allows to run Spring without installation. To do so all relevant files (binaries & basecontent) must be in a single folder, esp. spring(.exe), libunitsync.so/unitsync.dll and springsettings.cfg. Spring will then use the all-in-one-folder for writing and won’t do so anywhere else on the system, but it may open other files & directories for reading.
ISOLATION MODE¶
Not to confuse with Portable Mode, this mode disables all automatic Data Dir scanning and limit reading & writing to a single folder. This is very useful when games want to run separate from other Spring games. Isolation mode can be enabled by placing an empty isolated.txt next to the spring executable or by setting SPRING_ISOLATED env var.
DATA DIRS¶
Data directories are searched for content, and among other things, may contain:
Sorted by priority the engine may use multiple data directories, but it will use only the one with the highest priority as writable, to write cache & log files to. The hierarchy the engine loads DATA DIRs in can be grouped in 3 sections:
priority | section | normal | portable | isolation |
high | custom user write | -e directory defined via --write-dir SPRING_WRITEDIR envvar | -e directory defined via --write-dir SPRING_WRITEDIR envvar | -e directory defined via --write-dir SPRING_WRITEDIR envvar |
automatic scanned | -e CONFIG_HOME ETC_DIRS USR_SHARE | -e INSTALL_DIR CONFIG_HOME ETC_DIRS USR_SHARE | ISOLATION_DIR | |
low | custom user read | -e SPRING_DATADIR envvar SpringData configtag | -e SPRING_DATADIR envvar SpringData configtag | -e SPRING_DATADIR envvar SpringData configtag |
CONFIG_HOME
*nix/MacOSX:
~/.spring
Windows:
C:/.../My Documents/Spring/
C:/.../All Users/Applications/Spring/
INSTALL_DIR Location of spring-legacy binary.
ETC_DIRS Additional : separated DATA DIRs defined in /etc/spring/datadir.
USR_SHARE
MacOSX: .../Spring.app/Contents/Resources/share/games/spring/base/
Windows: Install directory
ISOLATION_DIR
Mode B (--isolation-dir): supplied dir
CONFIG FILES¶
Spring can load configurations from multiple files and merge them. So similar to DATA DIRs there is one file where the engine writes to and multiple read-only files.
It scans following directories for config files :
priority | scanned directories |
exclusive | file defined via --config (when defined only this is loaded) |
high | write DATA DIR |
-e (skipped in Isolated mode) *nix/MacOSX: ~/.springrc Windows: C:\Users\USER\AppData\Local\springsettings.cfg | |
low | all read DATA DIRs |
(The one with highest priority will be used for writing.)
The filename of such config files can be as following:
priority | filenames |
high | springsettings-%Engine_Version%.cfg |
springsettings.cfg | |
springrc-%Engine_Version% (*nix/MacOSX only) | |
low | springrc (*nix/MacOSX only) |
(An example for a versioned config file is "springsettings-94.1.cfg".)
SEE ALSO¶
HOMEPAGE¶
More information about Spring can be found at link: https://springrts.com
AUTHOR¶
Spring was written by the Spring developers.
This manual page was written by Marco Amadori <marco.amadori@gmail.com[1]>, for the Debian project (and may be used by others).
NOTES¶
- 1.
- marco.amadori@gmail.com
03/02/2021 | Spring package |