Reference

engine-dedicated(6)

An open source RTS game engine - Dedicated Server

Part of spring-dedicated(6).

NAME

spring-dedicated - An open source RTS game engine - Dedicated Server

SYNOPSIS

spring-dedicated [-i|--isolation] [--isolation-dir PATH] [-C|--config FILE] SCRIPT

spring-dedicated --list-config-vars

spring-dedicated [-h|--help]

spring-dedicated --sync-version

spring-dedicated [-V|--version]

DESCRIPTION

Spring is a free Real Time Strategy (RTS) game engine, originally designed to play Total Annihilation (© 1997 Cavedog) content. It has since evolved into a general RTS engine, capable of running various kind of games (mods).

It is mainly designed around online multiplayer games but can also be played in single-player mode against AIs.

This is the dedicated, GUI-less server for hosting multiplayer games. You need to feed it a start script in order to have it host a game. Start script are generated by lobby clients (SpringLobby) or autho-hosts (Spads, Springie). This is the most leight-weight version of the engine, which basically only redirects network traffic, while spring-headless still runs a full blown simulation of the game.

OPTIONS

-h, --help

Print the options help message and exit

-V, --version

Display program version and exit

--sync-version

Display program sync version (for online gaming) and exit

-i, --isolation

Limit the data-dir (games & maps) scanner to one directory (see --isolation-dir and the SPRING_ISOLATED env var)

--isolation-dir::'PATH'

Specify the isolation-mode data-dir (see --isolation and the SPRING_ISOLATED env var)

-C, --config::'FILE'

Configuration file

--list-config-vars

Dump all default config vars in JSON-format to STDOUT

DATA DIR

Data directories are searched for content, and among other things, may contain: *cache *games *maps *AI

When running the engine, it may use multiple data directories, but it will use only a single one of them as writable, to write cache & log files to.

FILES

~/.spring/

The default data-directory (see section DATA DIR).

~/.springrc

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_DATADIR Adds additional directories 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.

SEE ALSO

spring(6) spring-multithreaded(6) spring-headless(6)

HOMEPAGE

More information about Spring can be found at link: http://springrts.com

AUTHOR

Spring was written by the Spring developers.

This manual page was written by Marco Amadori <[email protected][1]>, for the Debian project (and may be used by others).

NOTES

1.

[email protected]