Fixed bug 966653

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

diff --git a/gameserv/gameserv.example.conf b/gameserv/gameserv.example.conf
index 2c9620d7f6ad430e16391871539516d0a2e51256..70ca4931db09c790ab620188c523b0488474a067 100644 (file)
--- a/gameserv/gameserv.example.conf
+++ b/gameserv/gameserv.example.conf
@@ -24,6 +24,9 @@ servername gameserv.yourdomain.com
 # GameServ Forest channel
 c_Forest #forest
 
+# True or false - whether or not to listen for commands on c_Forest
+listenonc_forest true
+
 # GameServ Forest Channel Topic
 c_ForestTopic The forest is dark and gloomy.
 
@@ -41,18 +44,40 @@ remotepass linkpass
 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 is a formatted string. You MUST include one %s and only
+# one %s. Do not put any %d %ld or other %s into this string! You will
+# break something, because there will be a leftover argument when it is
+# called in tcpclient.cpp, because that expects one %s and nothing else.
+# Comment this out to disable sending a welcome message
 welcomemsg Hello, %s! This network utilizes a services package called GameServ. For info on how to play the game, type /msg %S help.
 
+# This is an optional config file entry that allows you to specify
+# up to 32 servers that gameserv should completly ignore.
+# The list must be on one line, and there must be a space inbetween
+# each servername. Comment out or delete this line if you don't want
+# gameserv to ignore any servers.
+ignoreservers services.yourdomain.com stats.yourdomain.com
+
+# This is an optional config file entry that allows you to make
+# gameserv use privmsg instead of notice (/msg instead of /notice).
+# Uncomment it to enable using /msg, comment it or delete it to use /notice
+#USEPRIVMSG
+
+# This is an optional config file entry that allows you to specify
+# whether or not gameserv should be an oper or not.
+# Uncomment to make gameserv oper, comment it or delete it to leave gameserv 
+# as a regular user
+#BOPER
+
 ########## END IRC STUFF ##########
 
 
 # Filename to store player data in.
 playerdata players.dat
 
+# Filename to store news data in
+newsdata news.dat
+
 # Filename to load monsters from
 monsterdata monsters.dat
 
@@ -77,13 +102,30 @@ pidfile gameserv.pid
 # 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
 
+# This is the maximum time (in seconds) that a player may remain idle
+# before something naughty happens to them :)
+maxidletime 300
+
+# This is the period (in seconds) that gameserv will wait between
+# checking the entire players list for idlers.
+# Warning: bigger networks should not set this too low!
+# Minor Warning: This should be fairly close to the maxidletime, but
+#     it doesn't have to be. The farther the two are apart, the more
+#     random it gets.
+idlecheckperiod 300
+
 # Delete or comment this line so that GameServ will Load
 die You must read the entire config file!