1 # Sample ggzd configuration file
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
6 # It will save ggzd.conf from being overwritten. This behaviour was
7 # introduced with GGZ 0.0.14.
10 # Items marked "Not Implemented" won't work yet, and any options may be
11 # revised or eliminated in future versions! 'Nuff said.
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.
17 # The '=' sign is optional.
19 ############################################################################
20 # General Server Options
21 ############################################################################
26 # This is the server name as reported to clients
27 #ServerName = GGZ server
30 # This is the administrator name reported to clients
31 #AdminName = Honest Harry
33 # Administrators email
34 # This is the email contact address reported to clients
35 #AdminEmail = hharry@example.com
38 # Uncomment to specify a port other than the default (5688)
40 # It is possible to restrict access to one interface
41 #Interface = 127.0.0.1
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
49 #DatabaseUsername = ggzd
50 #DatabasePassword = ggzd
51 # DatabaseType: pgsql, mysql, sqlite, ...
53 # Database hashing: plain, md5, sha1 or ripemd160
54 #DatabaseHashing = plain
55 # Database hash encoding: base64 or base16 (defaults to base64)
56 #DatabaseHashEncoding = base64
58 # Transport Layer Security options
60 #EncryptionPassword = ggzrocksmore
61 #EncryptionKey = /usr/etc/ggzsite-example.pem
62 #EncryptionCert = /usr/etc/ggzsite-example.pem
64 # Announcements (none by default), metaserver must point to a GGZ metaserver
66 #AnnounceMetaserver = localhost
67 #AnnounceMetaserverUsername = ggzd
68 #AnnounceMetaserverPassword = ggzd
70 # Reconfiguration in case of room changes
73 ############################################################################
75 ############################################################################
80 # Dumps the complete network protocol traffic
81 # DumpFile can be either a filename, or 'stdout'/'stderr'
85 # Logfile can be either a filename, or 'syslogd', or 'stdout'/'stderr'
86 # syslogd is the default
87 LogFile = /var/log/ggz-server.log
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.
101 # Logfile can be either a filename, or 'syslogd', or 'stdout'/'stderr'
102 # syslogd is the default
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)
125 # Syslogd facility type to send logs to, default is local0
126 # (ignored if LOGFILE parm doesn't point to syslogd)
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!
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
142 # Should the date/time be included in log messages? (1=yes, 0=no)
143 # Default is 0 as you should be using syslogd.
147 # Should the game name be prepended to logs messages from a game server?
148 # eg: '[NetSpades] logmsg' (1=yes, 0=no)
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.
157 # How often to generate an update log entry? (in seconds)
158 #UpdateInterval = 600
160 ############################################################################
161 # Directory and File Options
162 ############################################################################
166 # Configuration directory
167 # This is where the server looks for game and room description files
171 # Where all server tables are stored if SQL is not used
172 DataDir = /var/lib/ggzd
174 # Game Servers directory
175 # This is where the server can find the game server modules
176 GameDir = @LIBDIR@/ggzd
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.
185 #WebMOTD = http://...
187 ############################################################################
189 ############################################################################
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
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
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
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
213 ############################################################################
214 # Miscellaneous Options
215 ############################################################################
219 # Default ping frequency to determine the lag class (seconds)
220 # A PingFrequency of 0 means no pings are sent; default is 10 seconds
223 # Default Lag Class Definitions
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
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.
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
244 #maxloadclients = 2.5
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
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
259 # Maximum clients (Not Implemented)
260 # This is the maximum number of active clients allowed at one time
261 # Default is no maximum
264 # Maximum tables (Not Implemented)
265 # This is the maximum number of active games before games cannot be launched
266 # Default is no maximum