spring(6)
=========
:man source:  Spring package
:man manual:  Games


Name
----
spring - An open source RTS game engine - Default Engine


Synopsis
--------
*spring* [-f|--fullscreen] [-w|--window] [-x|--xresolution 'SIZE'] [-y|--yresolution 'SIZE'] [-m|--minimise] [[-c|--client] | [-s|--server]] [-p|--projectiledump] [-t|--textureatlas] [-i|--isolation] [--isolation-dir 'PATH'] [-n|--name 'STRING'] [-C|--config 'FILE']

*spring* --list-ai-interfaces

*spring* --list-skirmish-ais

*spring* --list-config-vars

*spring* [-h|--help]

*spring* --sync-version

*spring* [-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.


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

*-f, --fullscreen*::
  Run in fullscreen mode

*-w, --window*::
  Run in windowed mode

*-x, --xresolution*::'SIZE'
  Set X resolution

*-y, --yresolution*::'SIZE'
  Set Y resolution

*-m, --minimise*::
  Start minimised

*-s, --server*::
  Run as a server

*-c, --client*::
  Run as a client

*-p, --projectiledump*::
  Dump projectile class info into projectiles.txt

*-t, --textureatlas*::
  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)

*-n, --name*::'NAME'
  Set your player name

 *-C, --config*::'FILE'
  Configuration file

*--list-ai-interfaces*::
  Dump a list of available AI Interfaces to STDOUT

*--list-skirmish-ais*::
  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
--------

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).
