WESNOTHD(6)

📦
version 1.16.11 · 2 versions
, in debian bookworm, ubuntu noble

bestie. welcome to the WESNOTHD(6) manual — aka the whole entire lore drop on wesnothd, the server daemon that runs your multiplayer games. grab a snack, we're going through everything. 🍓

✨ NAME ✨

wesnothd — the Battle for Wesnoth multiplayer network daemon. that's her. that's the girl. 💅

🎀 SYNOPSIS 🎀

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

🦋 DESCRIPTION 🦋

okay so wesnothd manages Battle for Wesnoth multiplayer games. that's the whole job, and she does it flawlessly, no cap.

if you wanna know what commands the server actually accepts — whether they come from the wesnoth client via /query ... or through the fifo — go read up at https://www.wesnoth.org/wiki/ServerAdministration. iykyk. 📖

🌸 OPTIONS 🌸

the flags, bestie. all of them. every single one. 👑

  • -c path, --config path — tells wesnothd where to find the config file to use. peep the SERVER CONFIG section below for the syntax. fun fact: you can reload the config by sending SIGHUP to the server process. iconic. 🔄
  • -d, --daemon — runs wesnothd as a daemon. she's independent now. main character energy. ✨
  • -h, --help — tells you what the command line options do. self-explanatory queen. 🙋‍♀️
  • --log-level=domain1,domain2,... — sets the severity level of the log domains. you can use all to match any log domain. available levels are: error, warning, info, debug. by default the error level is used, and the info level for the server domain. 📝
  • -p port, --port port — binds the server to the specified port. if no port is specified, port 15000 will be used. 🌈
  • -t number, --threads number — sets the maximum number of waiting worker threads for network I/O to n (default: 5, max: 30). 🧵
  • -T number, --max-threads number — sets the maximum number of worker threads that will be created. if set to 0 there will be no limit (default: 0). 🔥
  • -V, --version — shows version number and exits. bye bestie 👋
  • -v, --verbose — turns debug logging on. she's telling you everything. 💬

💜 SERVER CONFIG 💜

🧚 The general syntax is:

[tag]

key="value"

key="value,value,..."

[/tag]

👑 Global keys:

  • allow_remote_shutdown — if set to no (the default), shut_down and restart requests are ignored unless they come from the fifo. set it to yes to allow remote shutdown via a /query by an administrator. ⚠️
  • ban_save_file — full or relative path to a (gzip compressed) file that the server can read and write. bans get saved to this file and read again on server start. 📁
  • compress_stored_rooms — determines whether the rooms file should be read and written to in compressed form. defaults to yes.
  • connections_allowed — the number of allowed connections from the same IP. 0 means infinite. (default: 5)
  • disallow_names — names/nicks that are not accepted by the server. * and ? from wildcard patterns are supported. see glob(7) for more details. default values (used if nothing is specified) are: *admin*,*admln*,*server*,ai,ai?,computer,human,network,player.
  • fifo_path — the path to the fifo you can echo server commands into (same as /query ... from wesnoth). if not specified, it defaults to the compile-time path (default: /var/run/wesnothd/socket).
  • max_messages — the number of allowed messages in messages_time_period. (default: 4)
  • messages_time_period — the time period (in seconds) message flooding is detected in. (default: 10 seconds)
  • motd — the message of the day. 🌞
  • new_room_policy — determines who can create new rooms on the server. available values are everyone, registered, admin and nobody, and they give the permission respectively to everyone, registered users, admin users, or they disable new room creation entirely. default value is everyone.
  • passwd — the password used to gain admin privileges (via /query admin password). 🤫
  • replay_save_path — the directory where the server stores game replays. (don't forget the trailing /!!) defaults to `' which means the directory wesnothd was started in.
  • restart_command — the command that the server uses to start a new server process via the restart command. (can only be issued via the fifo. see the allow_remote_shutdown setting.)
  • room_save_file — path to a file where the room info should be stored. this file is read on server startup and written to later. if it's empty or not set, rooms are not loaded and not saved.
  • save_replays — defines whether the server will automatically save replays of games. (default: false)
  • versions_accepted — a comma separated list of version strings to be accepted by the server. * and ? from wildcard patterns are supported. (defaults to the corresponding wesnoth version) example: versions_accepted="*" accepts any version string.
  • deny_unregistered_login — whether to prevent users who are not registered with the user_handler being used from logging in. (default: false)

🌈 Global tags:

  • [redirect] — a tag to specify a server to redirect certain client versions to. it is not used if versions_accepted is not set.
    • host — the address of the server to redirect to.
    • port — the port to connect to.
    • version — a comma separated list of versions to redirect. behaves the same way as versions_accepted in regard to wildcard patterns.
  • [ban_time] — a tag to define convenient keywords for temporary ban time lengths. ⏰
    • name — the name used to reference the ban time.
    • time — the time length definition. the format is: %d[%s[%d%s[...]]] where %s is s (seconds), m (minutes), h (hours), D (days), M (months) or Y (years) and %d is a number. if no time modifier is given, minutes (m) are assumed. example: time="1D12h30m" results in a ban time of 1 day, 12 hours and 30 minutes.
  • [proxy] — a tag to tell the server to act as a proxy and forward the connected client's requests to the specified server. accepts the same keys as [redirect].
  • [user_handler] — configures the user handler. if no [user_handler] section is present in the configuration, the server will run without any nick registration service. all the additional tables that are needed for the forum_user_handler to function can be found in table_definitions.sql in the Wesnoth source repository. requires mysql support enabled — for cmake this is ENABLE_MYSQL, and for scons this is forum_user_handler.
    • db_host — the hostname of the database server
    • db_name — the name of the database
    • db_user — the name of the user under which to log into the database
    • db_password — this user's password
    • db_users_table — the name of the table in which your phpbb forums saves its user data. most likely this will be <table-prefix>_users (e.g. phpbb3_users).
    • db_extra_table — the name of the table in which wesnothd will save its own data about users.
    • db_game_info_table — the name of the table in which wesnothd will save its own data about games.
    • db_game_player_info_table — the name of the table in which wesnothd will save its own data about the players in a game.
    • db_game_modification_info_table — the name of the table in which wesnothd will save its own data about the modifications used in a game.
    • db_user_group_table — the name of the table in which your phpbb forums saves its user group data. most likely this will be <table-prefix>_user_group (e.g. phpbb3_user_group).
    • mp_mod_group — the ID of the forum group to be considered as having moderation authority.

💀 EXIT STATUS 💀

  • normal exit status is 0 when the server was properly shutdown. slay, clean exit. ✨
  • an exit status of 2 indicates an error with the command line options. not slay. 😭

🫶 AUTHOR 🫶

written by David White <davidnwhite@verizon.net>. edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net>, Soliton <soliton.de@gmail.com> and Thomas Baumhauer <thomas.baumhauer@gmail.com>. this manual page was originally written by Cyril Bouthors <cyril@bouthors.org>.

visit the official homepage: https://www.wesnoth.org/ 🌐

Copyright © 2003-2022 David White <davidnwhite@verizon.net>

this is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. fr fr. ⚠️

🌟 SEE ALSO 🌟

okay that's the whole page bestie, you ate that. 💅 this was the wesnothd manual from source/version wesnothd, dated 2022 — go forth and host some games. mwah 🎀✨

📦 where this page comes from