sample.conf

##Sample tpserver-cpp config file
## This file outlines the configuration options and syntax that can be used to
## configure tpserver-cpp

##About this file.
## If you use this file directly as a config file for tpserver-cpp, the defaults will
## be used.
## If you uncomment out the lines beginning with a single "#" character, you
## will still get the defaults.
## Lines starting with two "#" characters is the documention for this file.

##Directories and defaults
## By default the settings are taken from
##    /etc/tpserver-cpp/tpserver.conf
## but this can be overridden by adding these command line args
##    -C /dir/to/settingsfile.conf
## or
##    --configure /dir/to/settingsfile.conf
## or
##    --config_file /dir/to/settingsfile.conf
## All settings can set on the console once the server is running.

##SYNTAX
## Comments start with a "#" and go to the end of the line.
## The configuration lines have the format "<key> = <value>"
## Keys have a restricted set of characters.
## Values can be inclosed in single (') or double (") quotes, or not enclosed
## at all if the value has no spaces or quotes.
## The keys and possible (and default) values are outlined below.
## The last instance of the key in the file is used.


##Game settings

## game_name - the published name of the game.
## This is used when publishing the information about the game to identify the
## game. It does not need to be the dns name for the host.
## Defaults to Tpserver-cpp.
## Example: game_name = "My Thousand Parsec Game"
#game_name = Tpserver-cpp

## game_shortname - the short name of the game.
## This is used when publishing the information about the game to identify the
## game. It should be a few characters, lower case and now spaces.
## Defaults to "tp".
## Example: game_shortname = "mtpg"
#game_shortname = tp

## admin_email - the email address of the admin. This is optional and is published
## through to the metaserver and zeroconf.
## Example: admin_email = "lee@thousandparsec.net"
#admin_email =

## game_comment - a comment about the game. This is optional and is published
## through the metaserver.
## Example: game_comment = "This is a comment about this game."
#game_comment =

## ruleset - sets which ruleset to load.
## Setting this to the ruleset wanted will automatically load the ruleset named.
## If it is not set, no ruleset is loaded.
## Example: ruleset = minisec
#ruleset =

## persistence - set which persistence method to use.
## Automatically loads the named persistence method. If it is not set, the default
## in memory only persistence method is set.
## Example: persistence = tpmysql
#persistence =

## tpscheme - sets which TpScheme implementation to use.
## If set, loads the named TpScheme implementation. If not set or set to "auto"
## then an available implementation will be loaded.
## Example: tpscheme = tpmzscheme
## Example: tpscheme = tpguile
#tpscheme = auto

## game_load - automatically load the game.
## If set to "yes" then the game is automatically loaded ready to be started.
## In practice, at least ruleset above must be set.
#game_load = no

## game_start - automatically start the game.
## If set to "yes" then the game is automatically started and the end of turn
## timer set.
## In practice, game_load must be "yes" and succeed. You will want to set this
## configuration option once the server is running a game so that manual interaction
## is not required to get it running again after stopping the server. You will want to
## set network_start below to "yes" as well.
#game_start = no

## network_start - automatically start the network subsystem.
## If set to "yes" then the network subsystem is started and the listening sockets set.
## In practice, game_start must be "yes" and succeed. You will want to set this
## configuration option once the server is running a game so that manual interaction
## is not required to get it running again after stopping the server.
#network_start = no

## add_players - allows new players to join the game
## If set to "yes" then players that register using Account frames will join the
## game. When not set to "yes" no new players will join the game. The default
## is no, to prevent players joining until the game is ready.
#add_players = no

## autoadd_players - chooses weather new players are automatically created
##                               at login.
## If this setting is set to "yes" and add_players setting is set to "yes",
## if a player trys to login with a player name that
## is not currently know, a new player is created and added to the game. This
## is a method of self registersation. If playing a closed game, or the players
## are all set up, set to "no"
#autoadd_players = no

## game_media_base - the base url for media for the game.
## Sent to the clients to tell them where the base of the media tree is,
## which is also where the media.gz file is.
## Default is http://darcs.thousandparsec.net/repos/media/client/
## Example: game_media_base = "http://llnz.dyndns.org/tp/media/"
#game_media_base = "http://darcs.thousandparsec.net/repos/media/client/"

## battlexml_path - the base path to save battlexml files to.
## BattleXML files are saved on the local system. The path must exist.
## Default is /tmp
## Example: battlexml_path = "/var/lib/tp/battelxml/"
#battlexml_path = "/tmp/"

## noguest - Disable creating guest user
## This disables the creation of guest users for guests to look into the
## game. To prevent creating the guest user, set this to "yes".
## Example: noguest = yes
#noguest = no

##End of Turn Timer settings
## Some games may override these, some may provide different defaults

## turntimer - the name of the turn timer to use.
## Can be selected from basic, playersfinished, threshold.
## See http://www.thousandparsec.net/wiki/Tpserver-cpp/TurnTimers for more
## description.
## Default is basic.
## Example: turntimer = playersfinished
#turntimer = basic

## turn_length - Used by basic and playersfinished turntimers to set the max turn length.
## In the basic timer, the turn is turn_length seconds long. In the playersfinished, the 
## turn finishes when all the players are finished or after turn_length seconds, whichever
## is first. If set to 0, it is infinite in playersfinished and 60 seconds in basic.
## Default for basic: 60
## Default for playersfinish: 0
## Example: turn_length = 600
#turn_length = 0

## turn_players_min - the minimum number of players before playersfinished turntimer is active.
## This specifies the mimimum number of players before the playersfinished will end a
## turn early due to all players being finished. Defaults to two, have two players and the
## guest user before all finished turn ending.
## Example: turn_players_min = 5
#turn_players_min = 2

## turn_player_threshold - the threshold for changing from the under_threshold
## turn length to the over_threshold turn length. Set as a percentage of "alive" players
## that have sent frames saying they are finished for the turn.
## Becareful when setting this to 100 (ie 100%) and if the under_threshold
## is 0 (ie, no time limit) then the turn might never happen because a player doesn't send
## the TurnFinished frame.
## Default is 0, ie, always use over_threshold.
## Example: turn_player_threshold = 50 #50% of players finish before using over_threshold
#turn_player_threshold = 0

## turn_length_under_threshold - sets the length of the turn in seconds, unless the
## threshold is reached first.
## If set to 0, the end of turn timer will wait "forever" until the threshold is met.
## Default is 0 (wait until threshold)
## Example: turn_length_under_threshold = 86400 # 24 hours maximum time between turns
#turn_length_under_threshold = 0

## turn_length_over_threshold - sets the length of the turn in seconds, after the
## threshold has been reached.
## If set to 0, the end of turn will start immediately after the threshold is reached, unless
## the threshold is zero (and the length is defaulted up to 60 seconds).
## Default is 0 (do end of turn immediately, or 60 seconds if threshold is 0)
## Example: turn_length_over_threshold = 600 # 10 minutes for the rest of the player to finish
#turn_length_over_threshold = 0

## turn_require_active_players - sets if more than one active player is required to end turn early
## If set to no and even if there is only one active player, the turn can be ended early by players
## indicating that they have finished.
## Example: turn_require_active_player = no
#turn_require_active_player = yes

##Logging settings

## log_level - sets the level of logging done.
## This can be used to control the amount of output on the console.
## The value is an integer, coresponding to the lowest level that is logged:
## 0 - Debug output (default)
## 1 - Informational output (connects, disconnects, notices, etc)
## 2 - Warning output (Some types of failures, non-fatal, but possibly unfair)
## 3 - Error output (Errors, mostly fatal)
#log_level = 0

## log_colour - set weather to use colour for logging output to the terminal
## If logging to a terminal (command line/console), it maybe possible to use
## colour to make info, warning and error messages stand out. Most linux
## consoles support colour.  Colours used are:
## Red for errors
## Yellow for warnings
## Green for Info
## Standard console colour for debug.
## Only the message type is coloured (ie the "< Info  >" bit), the message
## itself is always in the standard console colour.
## To turn on colour, set to "yes"
#log_colour = no

## log_console - If you want to log to the console, this needs to be
## defined to "yes"
## Example: log_console = yes
#log_console = no

## log_file - To log to a file, define this to "yes" and set the logfile_name
## below.
## Example: log_file = yes
#log_file = no

## logfile_name - the file name to log to if file logging is enabled.
## Defaults to /var/log/tpserver-cpp.log.
#logfile_name = /var/log/tpserver-cpp.log

## log_syslog - As with console log, define this to yes to turn on logging to syslog.
## Example: log_syslog = yes
#log_syslog = no

## config_file - sets the config file to read.
## Sets the configuration file to read. Not exactly useful for inside the config
## file, but can be set from the command line.
## Defaults to /etc/tpserver-cpp/tpserver.conf
## STRONGLY recomend you *don't* uncomment the line below.
#config_file = /etc/tpserver-cpp/tpserver.conf


##Network settings

## tp_addr - the address to listen on for the tp (tcp, no tls) socket to listen on.
## Defaults to empty, empty is all addresses available. Set if you only want the
## tp socket to listen on a particular address.
#tp_addr =

## tp_port - sets the port the tp (tcp, no tls) socket listens on.
## Defaults to 0, which makes it listen on the default port (6923).
#tp_port = 0

## x509_tls - set if x509 certificate is to be used with TLS ports (tps and https).
## Set to "yes" if you have an x509 certificate you want to use. If you set this
## to yes, you should set x509_trust_file, x509_cert_file and x509_key_file.
#x509_tls = no

## x509_trust_file - set the trust file (CA-certificate) to use.
## No default.
#x509_trust_file =

## x509_cert_file - set the cert file (our certificate) to use.
## No default.
#x509_cert_file =

## x509_key_file - set the key file (our private key for our cert) to use.
## No default.
#x509_key_file =

## tps - selects weather tps socket is started when network is started.
## Only effective when TLS (gnutls) is configured. Defaults to no. Set
## to "yes" to have tps socket start.
#tps = no

## tps_addr - the address to listen on for the tps (tcp, tls) socket to listen on.
## Defaults to empty, empty is all addresses available. Set if you only want the
## tps socket to listen on a particular address.
#tps_addr =

## tps_port - sets the port the tp (tcp, tls) socket listens on.
## Defaults to 0, which makes it listen on the default port (6924).
#tps_port = 0

## https - selects weather https tunneling socket is started when network is
##             started.
## Only effective when TLS (gnutls) is configured. Defaults to no. Set
## to "yes" to have https socket start.
#https = no

## https_addr - the address to listen on for the https (https tunneling) socket
##                      to listen on.
## Defaults to empty, empty is all addresses available. Set if you only want the
## https socket to listen on a particular address.
#https_addr =

## https_port - sets the port the https (https tunneling) socket listens on.
## Defaults to 0, which makes it listen on the default port (443).
#https_port = 0

## http - selects weather http tunneling socket is started when network is
##             started.
## Defaults to no. Set to "yes" to have http socket start.
#http = no

## http_addr - the address to listen on for the http (http tunneling) socket
##                      to listen on.
## Defaults to empty, empty is all addresses available. Set if you only want the
## http socket to listen on a particular address.
#http_addr =

## http_port - sets the port the http (http tunneling) socket listens on.
## Defaults to 0, which makes it listen on the default port (80).
#http_port = 0


##Metaserver settings

## metserver_enable - enables the updates to the metaserver
## Set to "yes" to publish the games details to the metaserver.
## Defaults to "no" and therefore doesn't try to send updates to the metaserver.
#metaserver_enable = no

## metaserver_address - the hostname/address of the metaserver to publish
## the game's details to.
## Defaults to metaserver.thousandparsec.net if empty or not set.
#metaserver_address = metaserver.thousandparsec.net

## metaserver_port - the port to connect to the metaserver on.
## Defaults to port 80.
#metaserver_port = 80

## metaserver_interval - how often to send updates to the metaserver.
## Minimum 120, Max 600. Value in seconds.
## Defaults to 360 seconds (6 minutes)
# metaserver_interval = 360

## metaserver_fake_dns - the dns/hostname to fake to the metaserver.
## This is needed if you are behind a firewall, there are many dns
## names for this host, or the auto detection from the outgoing connection
## local end name is incorrect.
## Defaults to not set, therefore use the detected one.
#metaserver_fake_dns =

## metaserver_fake_ip - the ip address to fake to the metaserver.
## This is needed if you are behind a firewall, there are many ip
## addresses for this host, or the auto detection from the outgoing connection
## local ip address is incorrect.
## Defaults to not set, therefore use the detected one.
#metaserver_fake_ip =



##Remote Administration Settings

## admin_user - the username for remote administration.
## Defaults to "admin".
#admin_user = admin

## admin_pass - the password for remote administration.
## Defaults to "admin". It is advisable to change this for multiplayer games.
## Please set read permissions for the configuration file appropriately.
#admin_pass = admin

## admin_tcp - selects whether the admin tcp socket is started.
## Defaults to yes. Set to "no" to disable the admin tcp socket.
#admin_tcp = yes

## admin_tcp_addr - the address to listen on for the admin tcp socket to listen on.
## Defaults to empty, empty is all addresses available. Set if you only want the
## admin socket to listen on a particular address.
#admin_tcp_addr =

## admin_tcp_port - sets the port the admin tcp socket listens on.
## Defaults to 0, which makes it listen on the default port (6925).
#admin_tcp_port = 0

## Also see the individual module sample.conf files to see what config entries they support.