Updated Changes file

[irc/gameservirc.git] / gameserv / gameserv.example.conf

diff --git a/gameserv/gameserv.example.conf b/gameserv/gameserv.example.conf
index f52e153381b24d74f3c32ef99dd3b09dd207e871..92178718b08650e23db19915a328b8049e9be155 100644 (file)
--- a/gameserv/gameserv.example.conf
+++ b/gameserv/gameserv.example.conf
@@ -1,3 +1,13 @@
+# This is an example configuration file for GameServ that contains every
+# configuration directive necessary to properly load GameServ
+# You should read this file along with the Changes file for any updates
+# and changes to the config file directives.
+
+# You should copy this file to gameserv.conf then edit it. gameserv.conf
+# is the name of the config file that will be loaded at runtime.
+
+########## IRC STUFF ##########
+
 # Comments can only begin at the beginning of a line, and must begin with a pound (#)
 # GameServ Nickname
 s_GameServ GameServ
@@ -26,8 +36,59 @@ remoteport 6667
 # The password for linking to the real ircd 
 remotepass linkpass
 
+# Seconds to wait on load before displaying "Hello Nick" to new users
+# joining your network
+welcomedelay 10
+
+# Message that is displayed to new clients that join the IRC Network
+# Welcomemsg is a formatted string. To use it in a function that uses formatting like notice(), you must include a string
+# as an argument. i.e. notice(s_GameServ, u, welcomemsg, nick);
+# This is only true if you include anything like %s etc... if you include more than one %s or %d or anything, you must
+# include the proper type as an argument also.
+welcomemsg Hello, %s! This network utilizes a services package called GameServ. For info on how to play the game, type /msg %S help.
+
+########## END IRC STUFF ##########
+
+
 # Filename to store player data in.
 playerdata players.dat
 
+# Filename to load monsters from
+monsterdata monsters.dat
+
 # Password to control SHUTDOWN, LOAD, and SAVE
 adminpass apass
+
+# How often (in seconds) to save the player database. In case of accidental
+# shutdown or crash, this should be set fairly low. 180 seconds = 3 minutes.
+updateperiod 180
+
+# How many forest fights per day should everyone get
+forestfights 100
+
+# This is the filename for the gameserv process ID
+# This should be different between .conf files so you have different pid
+# files saved for each process (if you want)
+# If left the same for all processes, the pid file will hold the process
+# Id for the last run process
+pidfile gameserv.pid
+
+# This is the maximum number of levels above you a player
+# can be to be able to fight them.
+# ie. If this is set to 2, you can fight players two levels above you
+# eg. a level 1 player can fight a level 2 or 3 player, but not 4+
+# HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
+#       player fights only
+
+maxafightdistance 2
+
+# This is the maximum number of levels below you a player 
+# can be to be able to fight them.
+# ie. If this is set to 1, you can fight players 1 level below you
+# eg. a level 12 player can fight a level 11 player, but not 10 or below
+# HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
+#      player fights only
+maxbfightdistance 1
+
+# Delete or comment this line so that GameServ will Load
+die You must read the entire config file!