]> jfr.im git - irc/gameservirc.git/blob - gameserv/gameserv.example.conf
Fixed bug 966653
[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 # Seconds to wait on load before displaying "Hello Nick" to new users
43 # joining your network
44 welcomedelay 10
45
46 # Message that is displayed to new clients that join the IRC Network
47 # Welcomemsg is a formatted string. You MUST include one %s and only
48 # one %s. Do not put any %d %ld or other %s into this string! You will
49 # break something, because there will be a leftover argument when it is
50 # called in tcpclient.cpp, because that expects one %s and nothing else.
51 # Comment this out to disable sending a welcome message
52 welcomemsg Hello, %s! This network utilizes a services package called GameServ. For info on how to play the game, type /msg %S help.
53
54 # This is an optional config file entry that allows you to specify
55 # up to 32 servers that gameserv should completly ignore.
56 # The list must be on one line, and there must be a space inbetween
57 # each servername. Comment out or delete this line if you don't want
58 # gameserv to ignore any servers.
59 ignoreservers services.yourdomain.com stats.yourdomain.com
60
61 # This is an optional config file entry that allows you to make
62 # gameserv use privmsg instead of notice (/msg instead of /notice).
63 # Uncomment it to enable using /msg, comment it or delete it to use /notice
64 #USEPRIVMSG
65
66 # This is an optional config file entry that allows you to specify
67 # whether or not gameserv should be an oper or not.
68 # Uncomment to make gameserv oper, comment it or delete it to leave gameserv
69 # as a regular user
70 #BOPER
71
72 ########## END IRC STUFF ##########
73
74
75 # Filename to store player data in.
76 playerdata players.dat
77
78 # Filename to store news data in
79 newsdata news.dat
80
81 # Filename to load monsters from
82 monsterdata monsters.dat
83
84 # Password to control SHUTDOWN, LOAD, and SAVE
85 adminpass apass
86
87 # How often (in seconds) to save the player database. In case of accidental
88 # shutdown or crash, this should be set fairly low. 180 seconds = 3 minutes.
89 updateperiod 180
90
91 # How many forest fights per day should everyone get
92 forestfights 100
93
94 # This is the filename for the gameserv process ID
95 # This should be different between .conf files so you have different pid
96 # files saved for each process (if you want)
97 # If left the same for all processes, the pid file will hold the process
98 # Id for the last run process
99 pidfile gameserv.pid
100
101 # This is the maximum number of levels above you a player
102 # can be to be able to fight them.
103 # ie. If this is set to 2, you can fight players two levels above you
104 # eg. a level 1 player can fight a level 2 or 3 player, but not 4+
105 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
106 # player fights only
107
108 maxafightdistance 2
109
110 # This is the maximum number of levels below you a player
111 # can be to be able to fight them.
112 # ie. If this is set to 1, you can fight players 1 level below you
113 # eg. a level 12 player can fight a level 11 player, but not 10 or below
114 # HINT: Set maxbfightdistance and maxafightdistance to 0 to allow same level
115 # player fights only
116 maxbfightdistance 1
117
118 # This is the maximum time (in seconds) that a player may remain idle
119 # before something naughty happens to them :)
120 maxidletime 300
121
122 # This is the period (in seconds) that gameserv will wait between
123 # checking the entire players list for idlers.
124 # Warning: bigger networks should not set this too low!
125 # Minor Warning: This should be fairly close to the maxidletime, but
126 # it doesn't have to be. The farther the two are apart, the more
127 # random it gets.
128 idlecheckperiod 300
129
130 # Delete or comment this line so that GameServ will Load
131 die You must read the entire config file!