]> jfr.im git - irc/gameservirc.git/blob - gameserv/gameserv.example.conf
updated the Change log w/ new additions
[irc/gameservirc.git] / gameserv / gameserv.example.conf
1 # This is an example configuration file for GameServ that contains every
2 # configuration directive necessary to properly load GameServ
3 # You should read this file along with the Changes file for any updates
4 # and changes to the config file directives.
5
6 # You should copy this file to gameserv.conf then edit it. gameserv.conf
7 # is the name of the config file that will be loaded at runtime.
8
9 ########## IRC STUFF ##########
10
11 # Comments can only begin at the beginning of a line, and must begin with a pound (#)
12 # GameServ Nickname
13 s_GameServ GameServ
14
15 # GameServ Host
16 gshost yourdomain.com
17
18 # GameServ username (ie. username@host)
19 gsident GameServ
20
21 # Gameserv Psuedo Server Name
22 servername gameserv.yourdomain.com
23
24 # GameServ Forest channel
25 c_Forest #forest
26
27 # True or false - whether or not to listen for commands on c_Forest
28 listenonc_forest true
29
30 # GameServ Forest Channel Topic
31 c_ForestTopic The forest is dark and gloomy.
32
33 # The hostname/ip of the real ircd gameserv will be connected to
34 remoteserver 127.0.0.1
35
36 # The port on the real ircd gameserv will be connecting to
37 remoteport 6667
38
39 # The password for linking to the real ircd
40 remotepass linkpass
41
42 # The hostname of the local machine you wish to bind to when connecting
43 localhost 0.0.0.0
44
45 # This is a true/false type config directive.
46 # True: GameServ will attempt to identify with nickserv
47 # False: It will not (DEFAULT)
48 usenickserv false
49
50 # Your NickServ's nickname on your network. GameServ will use this to identify
51 # CAUTION: This will intentionally cause GameServ to send a PRIVMSG to your services
52 # *** This could cause an infinite loop if you use the USEPRIVMSG directive ***
53 # Either comment out USEPRIVMSG or add your services server to the ignore list
54 nsname NickServ
55
56 # The password GameServ will use to identify with your NickServ
57 nspass nickpassword
58
59 # Seconds to wait on load before displaying "Hello Nick" to new users
60 # joining your network
61 welcomedelay 10
62
63 # Message that is displayed to new clients that join the IRC Network
64 # Welcomemsg is a formatted string. You MUST include one %s and only
65 # one %s. Do not put any %d %ld or other %s into this string! You will
66 # break something, because there will be a leftover argument when it is
67 # called in tcpclient.cpp, because that expects one %s and nothing else.
68 # *****Comment this out to disable sending a welcome message*****
69 welcomemsg Hello, %s! This network utilizes a services package called GameServ. For info on how to play the game, type /msg %S help.
70
71 # This is an optional config file entry that allows you to specify
72 # up to 32 servers that gameserv should completly ignore.
73 # The list must be on one line, and there must be a space inbetween
74 # each servername. Comment out or delete this line if you don't want
75 # gameserv to ignore any servers.
76 # ***** Does not work on P10 servers yet *****
77 ignoreservers services.yourdomain.com stats.yourdomain.com
78
79 # This is an optional config file entry that allows you to make
80 # gameserv use privmsg instead of notice (/msg instead of /notice).
81 # Uncomment it to enable using /msg, comment it or delete it to use /notice
82 #USEPRIVMSG
83
84 # This is an optional config file entry that allows you to specify
85 # whether or not gameserv should be an oper or not.
86 # Uncomment to make gameserv oper, comment it or delete it to leave gameserv
87 # as a regular user
88 #BOPER
89
90 # This is a true/false type config directive.
91 # True: GameServ will send a message to the forest channel every time the
92 # player database is updated
93 # False: It will not (DEFAULT)
94 SAVEDNOTICE false
95
96 ########## END IRC STUFF ##########
97
98
99 # Filename to store player data in.
100 playerdata data/players.dat
101
102 # Filename to store the items in
103 itemdata data/items/masteritems.dat
104
105 # Filename to store the items that are abailable in the store
106 storeitemdata data/items/store.dat
107
108 # Filename to store the items that are available in the tavern
109 tavernitemdata data/items/tavern.dat
110
111 # Filename to store the master stats in
112 masterdata data/masters.dat
113
114 # Filename to store current dragon stats in.
115 dragondata data/currentdragon.dat
116
117 # This is the filename for the gameserv process ID
118 # This should be different between .conf files so you have different pid
119 # files saved for each process (if you want)
120 # If left the same for all processes, the pid file will hold the process
121 # Id for the last run process
122 pidfile gameserv.pid
123
124 # Filename to store news data in
125 newsdata news.dat
126
127
128 # Password to control SHUTDOWN, LOAD, and SAVE
129 adminpass apass
130
131 # How often (in seconds) to save the player database. In case of accidental
132 # shutdown or crash, this should be set fairly low. 180 seconds = 3 minutes.
133 updateperiod 180
134
135 # How often (in seconds) to refresh all players.
136 # 86400 Seconds in a day
137 # 43200 Seconds in 12 hours
138 # 3600 Seconds in an hour
139 refreshperiod 86400
140
141 # How many days until unused accounts at level 1 are deleted
142 level1expire 14
143
144 # How many days until unused accounts at all other levels are deleted
145 defaultexpire 30
146
147 # Maximum number of items a player can carry
148 maxitems 100
149
150 # How many forest fights per day should everyone get
151 # (this is the number of fights that will roll over if you say true below)
152 forestfights 100
153
154 # True or False - Should GameServ roll over the forestfights
155 rolloverforestfights false
156
157 # How often (in seconds) ro rollover forest fights
158 # 86400 Seconds in a day
159 # 43200 Seconds in 12 hours
160 # 3600 Seconds in an hour
161 rolloverperiod 864
162
163 # Maximum number of forest fights to roll over total. Forest fights per player will never
164 # Roll over to be above this number
165 maxforestfights 100
166
167 # Number of forest fights to roll over every rolloverperiod.
168 numrolloverfights 1
169
170 # This is the maximum number of levels above you a player
171 # can be to be able to fight them.
172 # ie. If this is set to 2, you can fight players two levels above you
173 # eg. a level 1 player can fight a level 2 or 3 player, but not 4+
174 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
175 # player fights only
176
177 maxafightdistance 2
178
179 # This is the maximum number of levels below you a player
180 # can be to be able to fight them.
181 # ie. If this is set to 1, you can fight players 1 level below you
182 # eg. a level 12 player can fight a level 11 player, but not 10 or below
183 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
184 # player fights only
185 maxbfightdistance 1
186
187 # Leave this as is if you want to enable fair fight checking
188 # This will not let a player fight another player if they will
189 # Kill the other player with 1 hit... useful for those pesky Level 1 players
190 # That have the best armor and weapons because they play way too much!
191 fairfights true
192
193 # This is the maximum time (in seconds) that a player may remain idle
194 # before something naughty happens to them :)
195 maxidletime 300
196
197 # This is the period (in seconds) that gameserv will wait between
198 # checking the entire players list for idlers.
199 # Warning: bigger networks should not set this too low!
200 # Minor Warning: This should be fairly close to the maxidletime, but
201 # it doesn't have to be. The farther the two are apart, the more
202 # random it gets.
203 idlecheckperiod 300
204
205 # This is the maximum length that a nickname can be
206 maxnicklen 20
207
208 # Delete or comment this line so that GameServ will Load
209 die You must read the entire config file!