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 ig‐
66 nored 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 in‐
80 finite. (default: 5)
81 deny_unregistered_login
83 Whether to prevent users who are not registered with the
84 user_handler being used from logging in. (default: false)
85 disallow_names
87 Names/nicks that are not accepted by the server. * and ? from
88 wildcard patterns are supported. See glob(7) for more details.
89 Default values (used if nothing is specified) are: *ad‐
90 min*,*admln*,*server*,ai,ai?,computer,human,network,player.
91 fifo_path
93 The path to the fifo you can echo server commands into (same as
94 /query ... from wesnoth). If not specified defaults to the com‐
95 pile-time path (default: /var/run/wesnothd/socket).
96 max_messages
98 The number of allowed messages in messages_time_period. (de‐
99 fault: 4)
100 messages_time_period
102 The time period (in seconds) message flooding is detected in.
103 (default: 10 seconds)
104 motd The message of the day.
106 new_room_policy
108 Determines who can create new rooms on the server. Available
109 values are everyone, registered, admin and nobody, and give the
110 permission respectively to everyone, registered users, admin
111 users or disables new room creation. Default value is everyone.
112 passwd The password used to gain admin privileges (via /query admin
114 password).
115 replay_save_path
117 The directory where the server stores game replays. (Don't for‐
118 get the trailing /!) Defaults to `' which means the directory
119 wesnothd was started in.
120 restart_command
122 The command that the server uses to start a new server process
123 via the restart command. (Can only be issued via the fifo. See
124 the allow_remote_shutdown setting.)
125 room_save_file
127 Path to a file where the room info should be stored. This file
128 is read on server startup and written to later. If empty or not
129 set, rooms are not loaded and not saved.
130 save_replays
132 Defines whether the server will automatically save replays of
133 games. (default: false)
134 tls_enabled
136 Enable use of TLS. If true, requires 3 following options to be
137 set too.
138 tls_fullchain
140 TLS full certificate chain in .pem format
141 tls_private_key
143 private key for TLS in .pem format
144 tls_dh TLS DH parameters, as .pem file. Generate with openssl dhparam
146 -out filename.pem 4096
147 versions_accepted
149 A comma separated list of version strings to be accepted by the
150 server. * and ? from wildcard patterns are supported. (defaults
151 to the corresponding wesnoth version)
152 Example: versions_accepted="*" accepts any version string.
153 id The ID of the server when using the database functionality to
155 store game information. Generally is the major.minor version of
156 accepted clients, such as 1.16 or 1.17.
157 Global tags:
159 [redirect] A tag to specify a server to redirect certain client ver‐
160 sions to. Is not used if versions_accepted is not set.
161 host The address of the server to redirect to.
163 port The port to connect to.
165 version
167 A comma separated list of versions to redirect. Behaves
168 the same way as versions_accepted in regard to wildcard
169 patterns.
170 [ban_time] A tag to define convenient keywords for temporary ban time
172 lengths.
173 name The name used to reference the ban time.
175 time The time length definition. The format is:
177 %d[%s[%d%s[...]]] where %s is s (seconds), m (minutes), h
178 (hours), D (days), M (months) or Y (years) and %d is a
179 number. If no time modifier is given minutes (m) are as‐
180 sumed. Example: time="1D12h30m" results in a ban time of
181 1 day, 12 hours and 30 minutes.
182 [proxy] A tag to tell the server to act as a proxy and forward the con‐
184 nected client's requests to the specified server. Accepts the same
185 keys as [redirect].
186 [user_handler] Configures the user handler. If no [user_handler] sec‐
188 tion is present in the configuration the server will run without any
189 nick registration service. All additional tables that are needed for
190 the forum_user_handler to function can be found in table_defini‐
191 tions.sql in the Wesnoth source repository. Requires mysql support en‐
192 abled. For cmake this is ENABLE_MYSQL and for scons this is fo‐
193 rum_user_handler.
194 db_host
196 The hostname of the database server
197 db_name
199 The name of the database
200 db_user
202 The name of the user under which to log into the database
203 db_password
205 This user's password
206 db_users_table
208 The name of the table in which your phpbb forum saves its
209 user data. Most likely this will be <table-prefix>_users
210 (e.g. phpbb3_users).
211 db_extra_table
213 The name of the table in which wesnothd will save its own
214 data about users.
215 db_game_info_table
217 The name of the table in which wesnothd will save its own
218 data about games.
219 db_game_player_info_table
221 The name of the table in which wesnothd will save its own
222 data about the players in a game.
223 db_game_modification_info_table
225 The name of the table in which wesnothd will save its own
226 data about the modifications used in a game.
227 db_user_group_table
229 The name of the table in which your phpbb forum saves its
230 user group data. Most likely this will be <table-pre‐
231 fix>_user_group (e.g. phpbb3_user_group).
232 db_connection_history_table
234 The name of the table in which to store login/logout
235 times. Also used for matching IPs to users and vice
236 versa.
237 db_topics_table
239 The name of the table in which your phpbb forum saves its
240 topic (thread) information. Most likely this will be <ta‐
241 ble-prefix>_topics (e.g. phpbb3_topics).
242 db_banlist_table
244 The name of the table in which your phpbb forum saves its
245 user bans data. Most likely this will be <table-pre‐
246 fix>_banlist (e.g. phpbb3_banlist).
247 mp_mod_group
249 The ID of the forum group to be considered as having mod‐
250 eration authority.
251
253 Normal exit status is 0 when the server was properly shutdown. An exit
254 status of 2 indicates an error with the command line options.
255
257 Written by David White <davidnwhite@verizon.net>. Edited by Nils Kneu‐
258 per <crazy-ivanovic@gmx.net>, ott <ott@gaon.net>, Soliton <soli‐
259 ton.de@gmail.com> and Thomas Baumhauer <thomas.baumhauer@gmail.com>.
260 This manual page was originally written by Cyril Bouthors
261 <cyril@bouthors.org>.
262 Visit the official homepage: https://www.wesnoth.org/
263
265 Copyright © 2003-2023 David White <davidnwhite@verizon.net>
266 This is Free Software; this software is licensed under the GPL version
267 2, as published by the Free Software Foundation. There is NO warranty;
268 not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
269
271 wesnoth(6)
272wesnothd 2022 WESNOTHD(6)