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