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

# 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

# GameServ Host
gshost yourdomain.com

# GameServ username (ie. username@host)
gsident GameServ

# Gameserv Psuedo Server Name
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.

# The hostname/ip of the real ircd gameserv will be connected to
remoteserver 127.0.0.1

# The port on the real ircd gameserv will be connecting to
remoteport 6667

# The password for linking to the real ircd 
remotepass linkpass

# The hostname of the local machine you wish to bind to when connecting
localhost 0.0.0.0

# This is a true/false type config directive.
# True: GameServ will attempt to identify with nickserv
# False: It will not (DEFAULT)
usenickserv false

# Your NickServ's nickname on your network. GameServ will use this to identify
# CAUTION: This will intentionally cause GameServ to send a PRIVMSG to your services
# *** This could cause an infinite loop if you use the USEPRIVMSG directive ***
# Either comment out USEPRIVMSG or add your services server to the ignore list
nsname NickServ

# The password GameServ will use to identify with your NickServ
nspass nickpassword

# 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. 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.
# You can use <S as many times as you want, though, because that is automatically
# Replaced with the s_GameServ variable.
# *****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.
# ***** Does not work on P10 servers yet *****
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

# This is a true/false type config directive.
# True: GameServ will send a message to the forest channel every time the
#       player database is updated
# False: It will not (DEFAULT)
SAVEDNOTICE false

########## END IRC STUFF ##########

# Filename to store player data in.
playerdata data/players.dat

# Filename to store the items in
itemdata data/items/masteritems.dat

# Filename to store the items that are abailable in the store
storeitemdata data/items/store.dat

# Filename to store the items that are available in the tavern
tavernitemdata data/items/tavern.dat

# Filename to store the master stats in
masterdata data/masters.dat

# Filename to store current dragon stats in.
dragondata data/currentdragon.dat

# Directory to look for scripts in - No trailing / necessary
scriptdir data/scripts

# 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

# Filename to store news data in
newsdata news.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 often (in seconds) to refresh all players.
# 86400 Seconds in a day
# 43200 Seconds in 12 hours
# 3600 Seconds in an hour
refreshperiod 86400

# How many days until unused accounts at level 1 are deleted
level1expire 14

# How many days until unused accounts at all other levels are deleted
defaultexpire 30

# Maximum number of items a player can carry
maxitems 100

# How many forest fights per day should everyone get 
# (this is the number of fights that will roll over if you say true below)
forestfights 100

# True or False - Should GameServ roll over the forestfights
rolloverforestfights false

# How often (in seconds) ro rollover forest fights
# 86400 Seconds in a day
# 43200 Seconds in 12 hours
# 3600 Seconds in an hour
rolloverperiod 864

# Maximum number of forest fights to roll over total. Forest fights per player will never
# Roll over to be above this number
maxforestfights 100

# Number of forest fights to roll over every rolloverperiod.
numrolloverfights 1

# 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

# Leave this as is if you want to enable fair fight checking
# This will not let a player fight another player if they will
# Kill the other player with 1 hit... useful for those pesky Level 1 players
# That have the best armor and weapons because they play way too much!
fairfights true

# 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

# This is the maximum length that a nickname can be
maxnicklen 20

# Delete or comment this line so that GameServ will Load
die You must read the entire config file!