1WESNOTHD(6)      Battle for Wesnoth multiplayer network daemon     WESNOTHD(6)
2
3
4

NAME

6       wesnothd - Battle for Wesnoth multiplayer network daemon
7

SYNOPSIS

9       wesnothd [-dv] [-c path] [-p port] [-t number] [-T number]
10       wesnothd -V
11

DESCRIPTION

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

OPTIONS

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
23       -d, --daemon
24              runs wesnothd as a daemon.
25
26       -h, --help
27              tells you what the command line options do.
28
29       --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
35       -p port, --port port
36              binds the server to the specified port. If no port is specified,
37              port 15000 will be used.
38
39       -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
43       -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
47       -V, --version
48              shows version number and exits.
49
50       -v, --verbose
51              turns debug logging on.
52

SERVER CONFIG

54   The general syntax is:
55       [tag]
56
57              key="value"
58
59              key="value,value,..."
60
61       [/tag]
62
63   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
69       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
74       compress_stored_rooms
75              Determines  whether the rooms file should be read and written to
76              in compressed form. Defaults to yes.
77
78       connections_allowed
79              The number of allowed connections from the same IP. 0 means  in‐
80              finite. (default: 5)
81
82       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:  *ad‐
86              min*,*admln*,*server*,ai,ai?,computer,human,network,player.
87
88       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
93       max_messages
94              The number of allowed  messages  in  messages_time_period.  (de‐
95              fault: 4)
96
97       messages_time_period
98              The  time  period  (in seconds) message flooding is detected in.
99              (default: 10 seconds)
100
101       motd   The message of the day.
102
103       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
109       passwd The  password  used  to  gain admin privileges (via /query admin
110              password).
111
112       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
117       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
122       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
127       save_replays
128              Defines whether the server will automatically  save  replays  of
129              games. (default: false)
130
131       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
137       deny_unregistered_login
138              Whether  to  prevent  users  who  are  not  registered  with the
139              user_handler being used from logging in. (default: false)
140
141   Global tags:
142       [redirect] A tag to specify a server to redirect  certain  client  ver‐
143       sions to.
144
145              host   The address of the server to redirect to.
146
147              port   The port to connect to.
148
149              version
150                     A  comma  separated list of versions to redirect. Behaves
151                     the same way as versions_accepted in regard  to  wildcard
152                     patterns.
153
154       [ban_time]  A  tag to define convenient keywords for temporary ban time
155       lengths.
156
157              name   The name used to reference the ban time.
158
159              time   The   time   length   definition.    The    format    is:
160                     %d[%s[%d%s[...]]] where %s is s (seconds), m (minutes), h
161                     (hours), D (days), M (months) or Y (years) and  %d  is  a
162                     number.  If no time modifier is given minutes (m) are as‐
163                     sumed.  Example: time="1D12h30m" results in a ban time of
164                     1 day, 12 hours and 30 minutes.
165
166       [proxy] A tag to tell the server to act as a proxy and forward the con‐
167       nected client's requests to the specified  server.   Accepts  the  same
168       keys as [redirect].
169
170       [user_handler] Configures the user handler. Available keys vary depend‐
171       ing on which user handler is set  with  the  user_handler  key.  If  no
172       [user_handler]  section is present in the configuration the server will
173       run without any nick registration service. All additional  tables  that
174       are  needed  for the forum_user_handler to function can be found in ta‐
175       ble_definitions.sql in the Wesnoth source repository.
176
177              db_host
178                     The hostname of the database server
179
180              db_name
181                     The name of the database
182
183              db_user
184                     The name of the user under which to log into the database
185
186              db_password
187                     This user's password
188
189              db_users_table
190                     The name of the table in which your  phpbb  forums  saves
191                     its  user  data.  Most  likely  this  will be <table-pre‐
192                     fix>_users (e.g. phpbb3_users).
193
194              db_extra_table
195                     The name of the table in which wesnothd will save its own
196                     data about users.
197
198              db_game_info_table
199                     The name of the table in which wesnothd will save its own
200                     data about games.
201
202              db_game_player_info_table
203                     The name of the table in which wesnothd will save its own
204                     data about the players in a game.
205
206              db_game_modification_info_table
207                     The name of the table in which wesnothd will save its own
208                     data about the modifications used in a game.
209
210              db_user_group_table
211                     The name of the table in which your  phpbb  forums  saves
212                     its user group data. Most likely this will be <table-pre‐
213                     fix>_user_group  (e.g. phpbb3_user_group).
214
215              mp_mod_group
216                     The ID of the forum group to be considered as having mod‐
217                     eration authority.
218

EXIT STATUS

220       Normal  exit status is 0 when the server was properly shutdown. An exit
221       status of 2 indicates an error with the command line options.
222

AUTHOR

224       Written by David White <davidnwhite@verizon.net>.  Edited by Nils Kneu‐
225       per   <crazy-ivanovic@gmx.net>,   ott  <ott@gaon.net>,  Soliton  <soli‐
226       ton.de@gmail.com> and  Thomas  Baumhauer  <thomas.baumhauer@gmail.com>.
227       This   manual   page   was   originally   written   by  Cyril  Bouthors
228       <cyril@bouthors.org>.
229       Visit the official homepage: https://www.wesnoth.org/
230
232       Copyright © 2003-2021 David White <davidnwhite@verizon.net>
233       This is Free Software; this software is licensed under the GPL  version
234       2, as published by the Free Software Foundation.  There is NO warranty;
235       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
236

SEE ALSO

238       wesnoth(6)
239
240
241
242
243wesnothd                             2021                          WESNOTHD(6)
Impressum