ggz-server.conf

   1 # Sample ggzd configuration file
   2 #
   3 # This file must be copied to 'ggzd.conf' or otherwise ggzd's compiled-
   4 # in values are used! Those are not necessarily the same as the commented
   5 # values in this file.
   6 # It will save ggzd.conf from being overwritten. This behaviour was
   7 # introduced with GGZ 0.0.14.
   8 #
   9 # Note:
  10 # Items marked "Not Implemented" won't work yet, and any options may be
  11 # revised or eliminated in future versions!  'Nuff said.
  12 #
  13 # Case of variable names is ignored, AddGame, addgame and ADDGAME are
  14 # all equivalent variable names.  Whitespace is ignored except WITHIN
  15 # the RHS of a configuration option.  Trailing whitespace is trunced.
  16 #
  17 # The '=' sign is optional.
  18
  19 ############################################################################
  20 # General Server Options
  21 ############################################################################
  22
  23 [General]
  24
  25 # Server name
  26 #   This is the server name as reported to clients
  27 #ServerName = GGZ server
  28
  29 # Administrators name
  30 #   This is the administrator name reported to clients
  31 #AdminName = Honest Harry
  32
  33 # Administrators email
  34 #   This is the email contact address reported to clients
  35 #AdminEmail = hharry@example.com
  36
  37 # Port option
  38 #   Uncomment to specify a port other than the default (5688)
  39 Port = 5688
  40 #   It is possible to restrict access to one interface
  41 #Interface = 127.0.0.1
  42
  43 # SQL database connection options
  44 #   If a SQL database is used as opposed to a flat embedded
  45 #   database, this block must be configured. DatabaseType
  46 #   is only relevant for the DBI backend.
  47 #DatabaseHost = localhost
  48 #DatabaseName = ggz
  49 #DatabaseUsername = ggzd
  50 #DatabasePassword = ggzd
  51 #   DatabaseType: pgsql, mysql, sqlite, ...
  52 DatabaseType = db4
  53 #   Database hashing: plain, md5, sha1 or ripemd160
  54 #DatabaseHashing = plain
  55 #   Database hash encoding: base64 or base16 (defaults to base64)
  56 #DatabaseHashEncoding = base64
  57
  58 # Transport Layer Security options
  59 #EncryptionUse = 0
  60 #EncryptionPassword = ggzrocksmore
  61 #EncryptionKey = /usr/etc/ggzsite-example.pem
  62 #EncryptionCert = /usr/etc/ggzsite-example.pem
  63
  64 # Announcements (none by default), metaserver must point to a GGZ metaserver
  65 #AnnounceLAN = 1
  66 #AnnounceMetaserver = localhost
  67 #AnnounceMetaserverUsername = ggzd
  68 #AnnounceMetaserverPassword = ggzd
  69
  70 # Reconfiguration in case of room changes
  71 #ReconfigureRooms = 1
  72
  73 ############################################################################
  74 # Logging Options
  75 ############################################################################
  76
  77 [Logs]
  78
  79 # DumpFile
  80 #   Dumps the complete network protocol traffic
  81 #   DumpFile can be either a filename, or 'stdout'/'stderr'
  82 #DumpFile = stderr
  83
  84 # Logfile
  85 #   Logfile can be either a filename, or 'syslogd', or 'stdout'/'stderr'
  86 #   syslogd is the default
  87 LogFile = /var/log/ggz-server.log
  88
  89 # Log types
  90 #   The types of logging which the server performs to the logfile
  91 #   Default is to log errors.  Types should be separated by a space.
  92 #   Valid types:  All
  93 #                 Notices
  94 #                 Connections
  95 #                 Security
  96 #                 Update
  97 #                 Tables
  98 LogTypes = All
  99
 100 # Debug logfile
 101 #   Logfile can be either a filename, or 'syslogd', or 'stdout'/'stderr'
 102 #   syslogd is the default
 103 #DebugFile = stderr
 104
 105 # Debug types
 106 #   The types of debugging information which the server sends to the
 107 #   debug files.  Default is NONE.
 108 #   (Server must be compiled with debug on to use this feature)
 109 #   Valid types:  All
 110 #                 Configuration
 111 #                 Process
 112 #                 Connection
 113 #                 Chat
 114 #                 Table
 115 #                 Protocol
 116 #                 Update
 117 #                 Misc
 118 #                 Room
 119 #                 Lists
 120 #                 Game_Msg
 121 #                 XML
 122 DebugTypes = All
 123
 124 # Syslogd facility
 125 #   Syslogd facility type to send logs to, default is local0
 126 #   (ignored if LOGFILE parm doesn't point to syslogd)
 127 #Facility = local0
 128
 129 # Append _PID to log filenames
 130 #   Should we have a separate logfile for each process thread?  (1=yes, 0=no)
 131 #   Default is 0, invalid for syslogd
 132 # WARNING: This is ugly, really really ugly.  It involves opening and closing
 133 #          the logfiles for each and every log message.  Don't use it!
 134 #ThreadLogs = 1
 135
 136 # PID in logs
 137 #   Should the PID be included in log messages?  (1=yes, 0=no)
 138 #   Default is 1 for standard log, Debug log ALWAYS includes PID
 139 #PIDInLogs = 0
 140
 141 # Timestamps in logs
 142 #   Should the date/time be included in log messages?  (1=yes, 0=no)
 143 #   Default is 0 as you should be using syslogd.
 144 #TimeInLogs = 1
 145
 146 # GameType in logs
 147 #   Should the game name be prepended to logs messages from a game server?
 148 #   eg: '[NetSpades] logmsg' (1=yes, 0=no)
 149 #   Default is 1
 150 #GameTypeInLogs = 0
 151
 152 # Update Log Config
 153 #   Should the update log be human readable?  (1=yes, 0=no)
 154 #   The update log can be either verbose (human readable) or not.  If you
 155 #   plan on writing/using a script to read the updates, turn off verbose.
 156 #VerboseUpdates = 1
 157 #   How often to generate an update log entry? (in seconds)
 158 #UpdateInterval = 600
 159
 160 ############################################################################
 161 # Directory and File Options
 162 ############################################################################
 163
 164 [Directories]
 165
 166 # Configuration directory
 167 #   This is where the server looks for game and room description files
 168 ConfDir = /etc/ggzd
 169
 170 # Data directory
 171 #   Where all server tables are stored if SQL is not used
 172 DataDir = /var/lib/ggzd
 173
 174 # Game Servers directory
 175 #   This is where the server can find the game server modules
 176 GameDir = @LIBDIR@/ggzd
 177
 178 [Files]
 179
 180 # MOTD File
 181 #   File in ConfDir containing MOTD to be sent to clients.  If the
 182 #   file doesn't exist, no message of the day will be sent.
 183 #   WebMOTD can be used in addition for clients which can display it.
 184 #MOTD = ggzd.motd
 185 #WebMOTD = http://...
 186
 187 ############################################################################
 188 # Game Options
 189 ############################################################################
 190
 191 [Games]
 192
 193 # List of Games
 194 #   A list of all games to be included.  If not present then the default is
 195 #   to add all games which can be found.
 196 # GameList = ccheckers chess connectx escape geekgame ggzcards-bridge dots
 197
 198 # List of Ignored Games
 199 #   If no GameList is specified, this entry can be used to specify a list
 200 #   of games which are to be skipped.
 201 #IgnoredGames = tictactoe
 202
 203 # List of Rooms
 204 #   A list of all rooms to be included.  If not present then the default is
 205 #   to add all rooms which can be found.
 206 #RoomList = ggzd_casual
 207
 208 # List of Ignored Rooms
 209 #   If no RoomList is specified, this entry can be used to specify a list
 210 #   of rooms which are to be skipped.
 211 #IgnoredRooms = ggzd_competitive
 212
 213 ############################################################################
 214 # Miscellaneous Options
 215 ############################################################################
 216
 217 [Miscellaneous]
 218
 219 # Default ping frequency to determine the lag class (seconds)
 220 #   A PingFrequency of 0 means no pings are sent; default is 10 seconds
 221 #PingFrequency = 10
 222
 223 # Default Lag Class Definitions
 224 #   Times are in msec
 225 #LagClass1 = 500
 226 #LagClass2 = 1000
 227 #LagClass3 = 2000
 228 #LagClass4 = 5000
 229
 230 # Interval at which to send players room occupancy updates (seconds)
 231 #   A value of 0 means no updates are sent; default is 60 seconds
 232 #RoomUpdateFrequency = 60
 233
 234 # Client hostname lookups
 235 #   Should the server do hostname lookups on the client's IP address?
 236 #   (1=yes, 0=no)  Default is 0, even though the lookup is done in the
 237 #   client thread and doesn't pause the server itself.
 238 #HostnameLookup = 1
 239
 240 # Load thresholds (Not Implemented)
 241 #   This is the load threshold where ggzd will start denying client
 242 #   connections and/or table launches.  The default is not to use a load
 243 #   threshold
 244 #maxloadclients = 2.5
 245 #maxloadtables = 2.5
 246
 247 # Load binary (Not Implemented)
 248 #   This is a binary that ggzd can execute to determine the servers
 249 #   load average.  The second parameter is the word to use as the load
 250 #loadbinary = /usr/bin/uptime, 10
 251
 252 # Load proc file (Not Implemented)
 253 #   If your system supports the /proc directory (eg: Linux), then this
 254 #   file will be queried for system load.  The second paramter is the
 255 #   word to use as the load.  This will be used in preference to loadbinary
 256 #   if both options are coded.
 257 #loadfile = /proc/loadavg, 2
 258
 259 # Maximum clients (Not Implemented)
 260 #   This is the maximum number of active clients allowed at one time
 261 #   Default is no maximum
 262 #maxclients = 1000
 263
 264 # Maximum tables (Not Implemented)
 265 #   This is the maximum number of active games before games cannot be launched
 266 #   Default is no maximum
 267 #maxtables = 150