Scroll to navigation

SPRING-HEADLESS(6) Games SPRING-HEADLESS(6)

NAME

spring-headless - An open source RTS game engine - Headless Engine

SYNOPSIS

spring-headless [--safemode] [[-c|--client] | [-s|--server]] [-p|--projectiledump] [-i|--isolation] [--isolation-dir PATH] [-n|--name STRING] [-C|--config FILE] SCRIPT
 
spring-headless --list-ai-interfaces
 
spring-headless --list-skirmish-ais
 
spring-headless --list-config-vars
 
spring-headless [-h|--help]
 
spring-headless --sync-version
 
spring-headless [-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 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.

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
--safemode
Turns off many things that are known to cause problems (i.e. on PC/Mac’s with lower-end graphic cards)
-s, --server
Run as a server
-c, --client
Run as a client
-p, --projectiledump
Dump projectile class info (alias CEG classes) into projectiles.txt
-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(6) spring-multithreaded(6) 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[1]>, for the Debian project (and may be used by others).

NOTES

1.
marco.amadori@gmail.com
mailto:marco.amadori@gmail.com
05/10/2012 Spring package