]> jfr.im git - irc/gameservirc.git/blob - gameserv/gameserv.example.conf
Added a help file for the set command
[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 # This is a true/false type config directive.
43 # True: GameServ will attempt to identify with nickserv
44 # False: It will not (DEFAULT)
45 usenickserv false
46
47 # Your NickServ's nickname on your network. GameServ will use this to identify
48 # CAUTION: This will intentionally cause GameServ to send a PRIVMSG to your services
49 # *** This could cause an infinite loop if you use the USEPRIVMSG directive ***
50 # Either comment out USEPRIVMSG or add your services server to the ignore list
51 nsname NickServ
52
53 # The password GameServ will use to identify with your NickServ
54 nspass nickpassword
55
56 # Seconds to wait on load before displaying "Hello Nick" to new users
57 # joining your network
58 welcomedelay 10
59
60 # Message that is displayed to new clients that join the IRC Network
61 # Welcomemsg is a formatted string. You MUST include one %s and only
62 # one %s. Do not put any %d %ld or other %s into this string! You will
63 # break something, because there will be a leftover argument when it is
64 # called in tcpclient.cpp, because that expects one %s and nothing else.
65 # *****Comment this out to disable sending a welcome message*****
66 welcomemsg Hello, %s! This network utilizes a services package called GameServ. For info on how to play the game, type /msg %S help.
67
68 # This is an optional config file entry that allows you to specify
69 # up to 32 servers that gameserv should completly ignore.
70 # The list must be on one line, and there must be a space inbetween
71 # each servername. Comment out or delete this line if you don't want
72 # gameserv to ignore any servers.
73 # ***** Does not work on P10 servers yet *****
74 ignoreservers services.yourdomain.com stats.yourdomain.com
75
76 # This is an optional config file entry that allows you to make
77 # gameserv use privmsg instead of notice (/msg instead of /notice).
78 # Uncomment it to enable using /msg, comment it or delete it to use /notice
79 #USEPRIVMSG
80
81 # This is an optional config file entry that allows you to specify
82 # whether or not gameserv should be an oper or not.
83 # Uncomment to make gameserv oper, comment it or delete it to leave gameserv
84 # as a regular user
85 #BOPER
86
87 # This is a true/false type config directive.
88 # True: GameServ will send a message to the forest channel every time the
89 # player database is updated
90 # False: It will not (DEFAULT)
91 SAVEDNOTICE false
92
93 ########## END IRC STUFF ##########
94
95
96 # Filename to store player data in.
97 playerdata players.dat
98
99 # Filename to store news data in
100 newsdata news.dat
101
102 # Password to control SHUTDOWN, LOAD, and SAVE
103 adminpass apass
104
105 # How often (in seconds) to save the player database. In case of accidental
106 # shutdown or crash, this should be set fairly low. 180 seconds = 3 minutes.
107 updateperiod 180
108
109 # How often (in seconds) to refresh all players.
110 # 86400 Seconds in a day
111 # 43200 Seconds in 12 hours
112 # 3600 Seconds in an hour
113 refreshperiod 86400
114
115 # How many days until unused accounts at level 1 are deleted
116 level1expire 14
117
118 # How many days until unused accounts at all other levels are deleted
119 defaultexpire 30
120
121 # How many forest fights per day should everyone get
122 forestfights 100
123
124 # This is the filename for the gameserv process ID
125 # This should be different between .conf files so you have different pid
126 # files saved for each process (if you want)
127 # If left the same for all processes, the pid file will hold the process
128 # Id for the last run process
129 pidfile gameserv.pid
130
131 # This is the maximum number of levels above you a player
132 # can be to be able to fight them.
133 # ie. If this is set to 2, you can fight players two levels above you
134 # eg. a level 1 player can fight a level 2 or 3 player, but not 4+
135 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
136 # player fights only
137
138 maxafightdistance 2
139
140 # This is the maximum number of levels below you a player
141 # can be to be able to fight them.
142 # ie. If this is set to 1, you can fight players 1 level below you
143 # eg. a level 12 player can fight a level 11 player, but not 10 or below
144 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
145 # player fights only
146 maxbfightdistance 1
147
148 # This is the maximum time (in seconds) that a player may remain idle
149 # before something naughty happens to them :)
150 maxidletime 300
151
152 # This is the period (in seconds) that gameserv will wait between
153 # checking the entire players list for idlers.
154 # Warning: bigger networks should not set this too low!
155 # Minor Warning: This should be fairly close to the maxidletime, but
156 # it doesn't have to be. The farther the two are apart, the more
157 # random it gets.
158 idlecheckperiod 300
159
160 # Delete or comment this line so that GameServ will Load
161 die You must read the entire config file!