1WESNOTHD(6) Battle for Wesnoth multiplayer network daemon WESNOTHD(6)
2
6 wesnothd - Battle for Wesnoth multiplayer network daemon
7
9 wesnothd [-dv] [-c path] [-p port] [-t number] [-T number]
10 wesnothd -V
11
13 Manages Battle for Wesnoth multiplayer games. See https://www.wes‐
14 noth.org/wiki/ServerAdministration on what commands the server accepts
15 via the wesnoth client (/query ...) or the fifo.
16
18 -c path, --config path
19 tells wesnothd where to find the config file to use. See the
20 section SERVER CONFIG below for the syntax. You can reload the
21 config with sending SIGHUP to the server process.
22 -d, --daemon
24 runs wesnothd as a daemon.
25 -h, --help
27 tells you what the command line options do.
28 --log-level=domain1,domain2,...
30 sets the severity level of the log domains. all can be used to
31 match any log domain. Available levels: error, warn‐
32 ing, info, debug. By default the error level is used and the
33 info level for the server domain.
34 -p port, --port port
36 binds the server to the specified port. If no port is specified,
37 port 15000 will be used.
38 -t number, --threads number
40 sets the maximum number of waiting worker threads for network
41 I/O to n (default: 5, max: 30).
42 -T number, --max-threads number
44 sets the maximum number of worker threads that will be created.
45 If set to 0 there will be no limit (default: 0).
46 -V, --version
48 shows version number and exits.
49 -v, --verbose
51 turns debug logging on.
52
54 The general syntax is:
55 [tag]
56 key="value"
58 key="value,value,..."
60 [/tag]
62 Global keys:
64 allow_remote_shutdown
65 If set to no (default), shut_down and restart requests are
66 ignored unless they come from the fifo. Set it to yes to allow
67 remote shutdown via a /query by an administrator.
68 ban_save_file
70 Full or relative path to a (gzip compressed) file that the
71 server can read and write. Bans will be saved to this file and
72 read again on server start.
73 compress_stored_rooms
75 Determines whether the rooms file should be read and written to
76 in compressed form. Defaults to yes.
77 connections_allowed
79 The number of allowed connections from the same IP. 0 means
80 infinite. (default: 5)
81 disallow_names
83 Names/nicks that are not accepted by the server. * and ? from
84 wildcard patterns are supported. See glob(7) for more details.
85 Default values (used if nothing is specified) are:
86 *admin*,*admln*,*server*,ai,ai?,computer,human,network,player.
87 fifo_path
89 The path to the fifo you can echo server commands into (same as
90 /query ... from wesnoth). If not specified defaults to the com‐
91 pile-time path (default: /var/run/wesnothd/socket).
92 max_messages
94 The number of allowed messages in messages_time_period.
95 (default: 4)
96 messages_time_period
98 The time period (in seconds) message flooding is detected in.
99 (default: 10 seconds)
100 motd The message of the day.
102 new_room_policy
104 Determines who can create new rooms on the server. Available
105 values are everyone, registered, admin and nobody, and give the
106 permission respectively to everyone, registered users, admin
107 users or disables new room creation. Default value is everyone.
108 passwd The password used to gain admin privileges (via /query admin
110 password).
111 replay_save_path
113 The directory where the server stores game replays. (Don't for‐
114 get the trailing /!) Defaults to `' which means the directory
115 wesnothd was started in.
116 restart_command
118 The command that the server uses to start a new server process
119 via the restart command. (Can only be issued via the fifo. See
120 the allow_remote_shutdown setting.)
121 room_save_file
123 Path to a file where the room info should be stored. This file
124 is read on server startup and written to later. If empty or not
125 set, rooms are not loaded and not saved.
126 save_replays
128 Defines whether the server will automatically save replays of
129 games. (default: false)
130 versions_accepted
132 A comma separated list of version strings to be accepted by the
133 server. * and ? from wildcard patterns are supported. (defaults
134 to the corresponding wesnoth version)
135 Example: versions_accepted="*" accepts any version string.
136 user_handler
138 The name of the user handler to use. Currently available user
139 handlers are forum (to connect wesnothd to a phpbb forum data‐
140 base) and sample (a sample implementation of the user handler
141 interface, if you use this on anything real you are insane). The
142 default value is forum. You must also add a [user_handler] sec‐
143 tion, see below.
144 Global tags:
146 [redirect] A tag to specify a server to redirect certain client ver‐
147 sions to.
148 host The address of the server to redirect to.
150 port The port to connect to.
152 version
154 A comma separated list of versions to redirect. Behaves
155 the same way as versions_accepted in regard to wildcard
156 patterns.
157 [ban_time] A tag to define convenient keywords for temporary ban time
159 lengths.
160 name The name used to reference the ban time.
162 time The time length definition. The format is:
164 %d[%s[%d%s[...]]] where %s is s (seconds), m (minutes), h
165 (hours), D (days), M (months) or Y (years) and %d is a
166 number. If no time modifier is given minutes (m) are
167 assumed. Example: time="1D12h30m" results in a ban time
168 of 1 day, 12 hours and 30 minutes.
169 [proxy] A tag to tell the server to act as a proxy and forward the con‐
171 nected client's requests to the specified server. Accepts the same
172 keys as [redirect].
173 [user_handler] Configures the user handler. Available keys vary depend‐
175 ing on which user handler is set with the user_handler key. If no
176 [user_handler] section is present in the configuration the server will
177 run without any nick registration service. All additional tables that
178 are needed for the forum_user_handler to function can be found in ta‐
179 ble_definitions.sql in the Wesnoth source repository.
180 db_host
182 (for user_handler=forum) The hostname of the database
183 server
184 db_name
186 (for user_handler=forum) The name of the database
187 db_user
189 (for user_handler=forum) The name of the user under which
190 to log into the database
191 db_password
193 (for user_handler=forum) This user's password
194 db_users_table
196 (for user_handler=forum) The name of the table in which
197 your phpbb forums saves its user data. Most likely this
198 will be <table-prefix>_users (e.g. phpbb3_users).
199 db_extra_table
201 (for user_handler=forum) The name of the table in which
202 wesnothd will save its own data about users. You will
203 have to create this table manually.
204 db_game_info_table
206 (for user_handler=forum) The name of the table in which
207 wesnothd will save its own data about games.
208 db_game_player_info_table
210 (for user_handler=forum) The name of the table in which
211 wesnothd will save its own data about the players in a
212 game.
213 db_game_modification_info_table
215 (for user_handler=forum) The name of the table in which
216 wesnothd will save its own data about the modifications
217 used in a game.
218 db_user_group_table
220 (for user_handler=forum) The name of the table in which
221 your phpbb forums saves its user group data. Most likely
222 this will be <table-prefix>_user_group (e.g.
223 phpbb3_user_group).
224 mp_mod_group
226 (for user_handler=forum) The ID of the forum group to be
227 considered as having moderation authority.
228 user_expiration
230 (for user_handler=sample) The time after which a regis‐
231 tered nick expires (in days).
232 [mail] Configures an SMTP server through which the user handler can
234 send mail. Currently only used by the sample user handler.
235 server The hostname of the mail server
237 username
239 The user name under which to log into the mail server.
240 password
242 This user's password.
243 from_address
245 The reply-to address of you mail.
246 mail_port
248 The port on which your mail server is running. Default is
249 25.
250
252 Normal exit status is 0 when the server was properly shutdown. An exit
253 status of 2 indicates an error with the command line options.
254
256 Written by David White <davidnwhite@verizon.net>. Edited by Nils Kneu‐
257 per <crazy-ivanovic@gmx.net>, ott <ott@gaon.net>, Soliton <soli‐
258 ton.de@gmail.com> and Thomas Baumhauer <thomas.baumhauer@gmail.com>.
259 This manual page was originally written by Cyril Bouthors
260 <cyril@bouthors.org>.
261 Visit the official homepage: https://www.wesnoth.org/
262
264 Copyright © 2003-2018 David White <davidnwhite@verizon.net>
265 This is Free Software; this software is licensed under the GPL version
266 2, as published by the Free Software Foundation. There is NO warranty;
267 not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
268
270 wesnoth(6)
271wesnothd 2018 WESNOTHD(6)