Clean up config file

irpg.conf

@@ -13,6 +13,9 @@
 # 'disablepeval' option was renamed to 'ownerpevalonly'
 #
 # Command line options override options in this file.
+#
+# Any setting marked "MUST SET" needs to be properly configured before the bot
+# is started for the first time.
 
 # remove or comment out this line so the bot knows that you edited the config
 # file
@@ -22,46 +25,63 @@ die
 # want to use a vhost
 #localaddr myvhost.domain.com
 
-# server name:port, enter as many as you like
-server miami.fl.us.irc-network.org:6667
-server dallas.tx.us.irc-network.org:7000
-server brussels.be.eu.irc-network.org:6660
+# MUST SET: server name:port, enter as many as you like
+#server miami.fl.us.irc-network.org:6667
+#server dallas.tx.us.irc-network.org:7000
+#server brussels.be.eu.irc-network.org:6660
+server chat.freenode.net:6667
 
-# bot's nickname
-botnick bot
+# MUST SET: bot's nickname
+botnick bot-nick
 
-# bot's username
-botuser bot
+# MUST SET: bot's username
+botuser bot-username
 
-# real name field
-botrlnm http://www.slashnet.org/~bot/
+# MUST SET: real name field
+botrlnm bot real name
 
-# channel name (followed by key, if your channel uses a key
-botchan #irpg s3cr3t.p4ss
+# MUST SET: channel name (followed by optional key, if your channel requires
+# a key)
+botchan #bot-channel s3cr3t.p4ss
 
-# (identify) command to send upon successful connect. if using a privmsg
-# command, you must begin the text of the message with a ":" -- see below
+# MUST SET: (identify) command to send upon successful connect. if using a
+# privmsg command, you must begin the text of the message with a ":" -- see
+# below last parameter is account password
+#
+# note: this is very dependent on the services being used.  The following
+# works on freenode and other networks using atheme or similar services
 botident PRIVMSG NickServ :identify ilovedink
 
-# modes to set bot upon successful connect
+# MUST SET: modes to set bot upon successful connect.  verify these are
+# correct for your network
 botmodes +ix
 
-# command to send upon joining channel. %botnick% will evaluate to the bot's
-# current nickname, so you don't have to worry about opping the wrong person. if
-# using a privmsg command, you must begin the text of the message with a ":" --
-# see below
-botopcmd PRIVMSG ChanServ :op #idlerpg %botnick%
+# MUST SET: command to send upon joining channel. %botnick% will evaluate to
+# the bot's current nickname, so you don't have to worry about opping the
+# wrong person. if using a privmsg command, you must begin the text of the
+# message with a ":" -- see below
+#
+# note: this is very dependent on the services being used.  The following
+# works on freenode and other networks using atheme or similar services
+botopcmd PRIVMSG ChanServ :op #bot-channel %botnick%
 
 # command sent to recover nick if bot's primary nickname is in use if using a
 # privmsg command, you must begin the text of the message with a ":" -- see
 # below
+#
+# note: this is very dependent on the services being used.  The following
+# works on freenode and other networks using atheme or similar services
+#
+# this is not currently properly implemented and is provided as a placeholder
 botghostcmd PRIVMSG NickServ :ghost bot ilovedink
 
 # URL to send users to for help
-helpurl http://idlerpg.net/
+# note: running the web code is not necessary but is _strongly_ encouraged
+helpurl http://localhost/
 
 # admin commands list (for admin help)
-admincommurl http://idlerpg.net/admincomms.txt
+# note: running the web code is not necessary but is _strongly_ encouraged
+admincommurl http://localhost/admincomms.txt
 
 # base time to level up, 600 = 10 minutes
 rpbase 600
@@ -104,6 +124,8 @@ silentmode 0
 # write quest info file? all this file does is give outside programs info
 # about the active quests, its participants, their positions, and time to
 # completion
+#
+# note: this is required for quest reloads on game restart to function
 writequestfile on
 
 # filename for the above-mentioned file
@@ -124,14 +146,14 @@ noccodes on
 # problems in the past with using binary hash keys
 nononp on
 
-# URL where users can reach the online quest map, if available. if not
-# offering a map to users, leave this blank
-mapurl http://idlerpg.net/quest.php
+# MUST SET: URL where users can reach the online quest map, if available.
+# if not offering a map to users, leave this blank
+mapurl http://localhost/quest.php
 
 # allow a STATUS command for users? this is a p0 command to view information
 # on an irpg user. useful if you don't have a website where users can view
 # their stats
-statuscmd off
+statuscmd on
 
 # filename to write our PID to. leave blank or comment out if pidfile is
 # unnecessary to you
@@ -188,17 +210,19 @@ noscale off
 # allow bot to access http://jotun.ultrazone.org/g7/count.php?new=1 each
 # time someone registers a new username? it only takes a second, and I'd
 # really like to be able to keep up with the total player count :^)
-phonehome on
+#
+# The above URL no longer resolves; disabled now by default
+phonehome off
 
 # username of the bot's owner. this account cannot be DELADMINed and has access
 # to PEVAL even if it is disabled
-owner jotun
+owner botadmin
 
 # disable the PEVAL command for non-owner accounts? this command allows the
 # execution of arbitrary Perl code by bot admins, effectively giving them
 # complete control of the account under which the bot runs. I prefer to leave
 # this command available and choose my admins with care, but, whatever :^)
-ownerpevalonly off
+ownerpevalonly on
 
 # only owner account can use the MKADMIN command to assign admin status to
 # users?
@@ -211,7 +235,9 @@ ownerdelonly on
 # check for newer versions each time the bot starts up? this will access the
 # URL http://jotun.ultrazone.org/g7/version.php?version=$version and report on
 # any updated versions and what features there are/bugs have been fixed
-checkupdates on
+#
+# The above URL no longer resolves; disabled now by default
+checkupdates off
 
 # send list of usernames that are automatically logged back in when we restart
 # (iff that list is < 1 k)? this should, hopefully, no longer cause the bot to
@@ -243,14 +269,19 @@ modesperline 3
 # do we want to receive new user repors emails?
 newuserreports off
 
-# where do new user emails go?
-newuserdest user\@email.tld
+# MUST SET: where do new user emails go; unnecessary if newuserreports is off
+#
+# note: the escape on the '@' is mandatory
+newuserdest user\@email.tld; ignored if newuserreports is off
 
-# From name on newuser report email
-newuserfromname IdleRPG Monitor
+# MUST SET: from addr on newuser report email; unnecessary if newuserreports
+# is off
+newuserfromaddr idlerpg-monitor\@email.tld; ignored if newuserreports is off
 
-# From addr on newuser report email
-newuserfromaddr idlerpg-monitor\@email.tld
+# MUST SET: from name on newuser report email; unnecessary if newuserreports
+# is off
+newuserfromname IdleRPG Monitor; ignored if newuserreports is off
 
-# game title used in channel announcements, emails, etc
+# MUST SET: game title used in channel announcements, emails, etc; unnecessary
+# if newuserreports is off
 gametitle game title