{BINARY}(6)
=========
:man source:  Spring package
:man manual:  Games

Name
----
ifdef::DEFAULT[{BINARY} - An open source RTS game engine - Default Engine]
ifdef::MULTITHREADED[{BINARY} - An open source RTS game engine - Multithreaded Engine]
ifdef::HEADLESS[{BINARY} - An open source RTS game engine - Headless Engine]
ifdef::DEDICATED[{BINARY} - An open source RTS game engine - Dedicated Server]

Synopsis
--------
ifndef::GUILESS[*{BINARY}* [-f|--fullscreen] [-w|--window] [-x|--xresolution 'SIZE'] [-y|--yresolution 'SIZE'] [-m|--minimise] [--safemode] [[-c|--client] | [-s|--server]] [-p|--projectiledump] [-t|--textureatlas] [-i|--isolation] [--isolation-dir 'PATH'] [-n|--name 'STRING'] [-C|--config 'FILE'] ['SCRIPT']]
ifdef::HEADLESS[*{BINARY}* [--safemode] [[-c|--client] | [-s|--server]] [-p|--projectiledump] [-i|--isolation] [--isolation-dir 'PATH'] [-n|--name 'STRING'] [-C|--config 'FILE'] SCRIPT]
ifdef::DEDICATED[*{BINARY}* [-i|--isolation] [--isolation-dir 'PATH'] [-C|--config 'FILE'] SCRIPT]
ifndef::DEDICATED[]

*{BINARY}* --list-ai-interfaces

*{BINARY}* --list-skirmish-ais
endif::DEDICATED[]

*{BINARY}* --list-config-vars

*{BINARY}* [-h|--help]

*{BINARY}* --sync-version

*{BINARY}* [-V|--version]

Description
-----------
Spring is a free Real Time Strategy (RTS) game engine, originally designed to
play Total Annihilation ((C) 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.

ifdef::DEDICATED[]
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.
endif::DEDICATED[]
ifdef::HEADLESS[]
This is the engine version without graphics or sound output.
It still runs the full simulation, while spring-dedicated basically
only redirects network traffic.
It is useful for testing and simulating AI only games at high speeds
on systems without graphics and sound output support.
endif::HEADLESS[]
ifdef::MULTITHREADED[]
This is the engine version which runs graphics and simulation
in two separate threads. This may boost performance on multi-core systems.
endif::MULTITHREADED[]

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
ifndef::GUILESS[ ]
ifndef::GUILESS[*-f, --fullscreen*::]
ifndef::GUILESS[  Run in fullscreen mode]
ifndef::GUILESS[ ]
ifndef::GUILESS[*-w, --window*::]
ifndef::GUILESS[  Run in windowed mode]
ifndef::GUILESS[ ]
ifndef::GUILESS[*-x, --xresolution*::'SIZE'::]
ifndef::GUILESS[  Set X resolution]
ifndef::GUILESS[ ]
ifndef::GUILESS[*-y, --yresolution*::'SIZE'::]
ifndef::GUILESS[  Set Y resolution]
ifndef::GUILESS[ ]
ifndef::GUILESS[*-m, --minimise*::]
ifndef::GUILESS[  Start minimised]
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*--safemode*::]
ifndef::DEDICATED[  Turns off many things that are known to cause problems (i.e. on PC/Mac's with lower-end graphic cards)]
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*-s, --server*::]
ifndef::DEDICATED[  Run as a server]
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*-c, --client*::]
ifndef::DEDICATED[  Run as a client]
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*-p, --projectiledump*::]
ifndef::DEDICATED[  Dump projectile class info (alias CEG classes) into projectiles.txt]
ifndef::GUILESS[ ]
ifndef::GUILESS[*-t, --textureatlas*::]
ifndef::GUILESS[  Dump each finalised textureatlas into textureatlasN.tga]

*-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)
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*-n, --name*::'NAME'::]
ifndef::DEDICATED[  Set your player name]

*-C, --config*::'FILE'::
  Configuration file
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*--list-ai-interfaces*::]
ifndef::DEDICATED[  Dump a list of available AI Interfaces to STDOUT]
ifndef::DEDICATED[ ]
ifndef::DEDICATED[*--list-skirmish-ais*::]
ifndef::DEDICATED[  Dump a list of available Skirmish AIs to STDOUT]

*--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
--------
ifndef::DEFAULT[spring(6)]
ifndef::MULTITHREADED[spring-multithreaded(6)]
ifndef::HEADLESS[spring-headless(6)]
ifndef::DEDICATED[spring-dedicated(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 <marco.amadori@gmail.com>,
for the Debian project (and may be used by others).
