Servers reference
Blocks
Each top-level key is one server block: DEFAULT, which carries the shared defaults (in-game messages, timeouts, rules) that every server inherits, or a server name as it appears in the server list. A server's own block wins over DEFAULT.
# config/servers.yaml
DEFAULT:
messages: # General messages for servers. You can overwrite any in any server.
greeting_message_members: '{player.name}, welcome back to {server.name}!'
greeting_message_unmatched: '{player.name}, please use /linkme in our Discord, if you want to see your user stats!'
message_player_username: Your player name contains invalid characters.
Please change your name to join our server. # Default message for players with invalid usernames
message_player_default_username: Please change your default player name at the top right
of the multiplayer selection list to an individual one! # Default message for players with default usernames
message_ban: 'You are banned from this server. Reason: {}' # default message, if a player is banned on the DCS server
message_reserved: 'This server is locked for specific users.\nPlease contact a server admin.' # Message if server requires discord role (optional)
message_no_voice: You need to be in voice channel "{}" to use this server! # default message, if you are not in Discord voice, but force_voice is on.
message_timeout: 10 # default timeout for DCS popup messages in seconds
profanity_filter: true # Use the profanity filter for the in-game chat (default: false).
display_ai_chat: false # do not display AI chat messages in the chat channel (default: false)
rules: | # Optional: Rules to be displayed for new users (needs MissionStats enabled!)
The full commented sample is samples/servers.yaml.
| Key | Type | Description | Example |
|---|---|---|---|
messages |
map | Per-server overrides for the bot's in-game messages. | greeting_message_members: '{player.name}, welcome back!' |
messages.greeting_message_members |
str | Greeting shown to linked members when they join. (range: min 1) | {player.name}, welcome back to {server.name}! |
messages.greeting_message_unmatched |
str | Greeting shown to players not yet linked to Discord. (range: min 1) | {player.name}, please use /linkme in our Discord! |
messages.message_player_username |
str | Warning for players whose name contains invalid characters. (range: min 1) | Your player name contains invalid characters. |
messages.message_player_default_username |
str | Warning for players still using a default name. (range: min 1) | Please change your default player name. |
messages.message_player_inappropriate_username |
str | Warning for players with an inappropriate name. (range: min 1) | Your username is inappropriate and needs to be changed. |
messages.message_ban |
str | Message shown to banned players ({}) is replaced by the reason. (range: min 1) | You are banned from this server. Reason: {} |
messages.message_reserved |
str | Message shown when a server is locked to specific users. (range: min 1) | This server is locked for specific users. |
messages.message_no_voice |
str | Message shown when voice channel membership is required. (range: min 1) | You need to be in voice channel "{}" to use this server! |
messages.message_seat_locked |
str | Message shown when a player's seat is locked. (range: min 1) | Your player is currently locked. |
message_timeout |
int | Lifetime of DCS popup messages in seconds. (range: min 5, max 60) | 10 |
display_ai_chat |
bool | Replicate AI chat messages to the Discord chat channel. | false |
profanity_filter |
bool | Filter profanity in player names and in-game chat. | true |
no_join_with_cursename |
bool | Block players whose names contain profanity. | true |
server_user |
str | Name of the server's first technical user. (range: min 1) | Admin |
show_passwords |
bool | Show the server password in the status embed. | true |
show_atis |
bool | Show ATIS information in the join popup. | true |
mission_rewrite |
bool | Rewrite the mission file before loading it. | false |
afk |
map | Automatic kick of players who sit idle (AFK). | afk_time: 900 |
afk.afk_time |
int | Seconds before a player counts as AFK (-1 disables). (range: min -1) | 900 |
afk.punish |
bool | Create an "afk" punishment instead of kicking. | false |
afk.threshold |
int | Only kick AFK players above this server fill percentage. (range: min 0, max 100) | 75 |
afk.check_on_join |
bool | Check for AFK while a player sits in slot selection. | true |
afk.check_on_spawn |
bool | Check for AFK while a player idles on the apron. | false |
afk.check_after_landing |
bool | Check for AFK after landing, before the next takeoff. | false |
afk.message |
str | Message shown to players kicked for being AFK. (range: min 1) | {player.name}, you have been kicked for being AFK. |
afk.exemptions |
map | UCIDs and Discord roles exempt from AFK kicks. | ucid: |
afk.exemptions.ucid |
list | UCIDs exempt from AFK kicks. | - aabbccddeeff1122334455 |
afk.exemptions.discord |
list | Discord role names exempt from AFK kicks. | - Donators |
usage_alarm |
map | Alert pings when server usage crosses thresholds. | min_threshold: 30 |
usage_alarm.min_threshold |
int | Alert when fewer players than this are online. (range: min 1) | 30 |
usage_alarm.max_threshold |
int | Alert when more players than this are online. (range: min 0) | 10 |
usage_alarm.role |
text | Discord role to ping for the usage alarm. | DCS Admin |
usage_alarm.channel |
int | Discord channel for the usage alarm (default admin). | 1122334455 |
slot_spamming |
map | Limit how often a player may change slots. | message: You have been kicked for slot spamming! |
slot_spamming.message |
str | Message shown to players kicked for slot spamming. (range: min 1) | You have been kicked for slot spamming! |
slot_spamming.check_time |
int | Length of the observation window in seconds. | 5 |
slot_spamming.slot_changes |
int | Allowed slot changes within the observation window. | 5 |
ping_admin_on_crash |
bool | Ping the DCS Admin role when the server crashes. | true |
autoscan |
bool | Scan for new missions and auto-add them to the list. | false |
autoscan_observer |
str | How the missions folder is watched. auto uses polling when the folder is a network share (UNC, mapped drive or a junction into one) and file notifications otherwise. (one of: auto, notify, polling) | auto |
autoscan_poll_interval |
int | Seconds between polls of the missions folder (polling observer only). (range: min 1) | 3 |
autoscan_stable_timeout |
int | Seconds a new mission file may keep growing before autoscan gives up on it. (range: min 1) | 60 |
ignore_dirs |
list | Directories skipped during mission upload and add. | - archive |
autoadd |
bool | Auto-add uploaded missions to the mission list. | true |
validate_missions |
bool | Check that missions can load (maps, modules) before use. | true |
autorole |
text | Role granted to players online on this server. | Fancy Players |
smooth_pause |
int | Seconds a PAUSE-on-start server runs before pausing again. | 5 |
lock_on_load |
int | Seconds to lock a server after a mission restart. | 120 |
force_voice |
bool | Require players to join a Discord voice channel. | false |
rules |
str | Rules text displayed to new players (needs MissionStats). (range: min 1) | These are the rules to play on this server: |
accept_rules_on_join |
bool | Require acknowledgement of the rules on join. | true |
smart_bans |
bool | Enable the smart ban system (IPv4 reuse detection). | true |
serverSettings |
map | |
|
serverSettings.bind_address |
str | IP address the DCS server binds its network interface to. (range: min 1) | 0.0.0.0 |
serverSettings.description |
str | Description shown next to the server in the multiplayer list. | Our training server |
serverSettings.isPublic |
bool | Publish the server in the public multiplayer server list. | true |
serverSettings.listLoop |
bool | Restart the mission list from the top after the last mission. | true |
serverSettings.listShuffle |
bool | Shuffle the mission list order before each rotation. | false |
serverSettings.maxPlayers |
text | Maximum number of players allowed on the server. | 64 |
serverSettings.name |
str | Server name shown in the multiplayer server list. (range: min 1) | My Fancy Server |
serverSettings.password |
str | Password players must enter to join the server. | |
serverSettings.port |
text | UDP port the DCS server listens on. | 10308 |
serverSettings.mode |
text | Server visibility mode as advertised in the server list. | 0 |
serverSettings.require_pure_clients |
bool | Reject clients whose DCS installation is not pure. | true |
serverSettings.require_pure_models |
bool | Reject clients carrying modified models. | true |
serverSettings.require_pure_scripts |
bool | Reject clients carrying modified scripts. | true |
serverSettings.require_pure_textures |
bool | Reject clients carrying modified textures. | true |
serverSettings.missionList |
list | Missions pre-loaded into the server's mission list. | - MyMission |
serverSettings.advanced |
map | Advanced DCS settings written to serverSettings.lua. | client_outbound_limit: 400000 |
serverSettings.advanced.client_outbound_limit |
text | Outbound network bandwidth limit per client in bytes/s. | 400000 |
serverSettings.advanced.client_inbound_limit |
text | Inbound network bandwidth limit per client in bytes/s. | 400000 |
serverSettings.advanced.disable_events |
bool | Disable the DCS event system for this server. | false |
serverSettings.advanced.maxPing |
text | Maximum allowed client ping in milliseconds. | 500 |
serverSettings.advanced.pause_on_load |
bool | Pause the server automatically after loading a mission. | false |
serverSettings.advanced.pause_without_clients |
bool | Pause the server while no clients are connected. | true |
serverSettings.advanced.resume_mode |
text | How the server resumes from a paused state. | 0 |
serverSettings.advanced.server_can_screenshot |
bool | Allow clients to take screenshots on the server. | true |
serverSettings.advanced.voice_chat_server |
bool | Enable the built-in DCS voice chat server. | true |
serverSettings.advanced.allow_change_skin |
bool | Allow players to change their aircraft livery. | true |
serverSettings.advanced.allow_change_tailno |
bool | Allow players to change their aircraft tail number. | true |
serverSettings.advanced.allow_dynamic_radio |
bool | Allow players to use dynamic radio channel assignment. | true |
serverSettings.advanced.allow_ownship_export |
bool | Allow export of own-ship data to external tools. | true |
serverSettings.advanced.allow_object_export |
bool | Allow export of object data to external tools. | false |
serverSettings.advanced.allow_players_pool |
bool | Allow players to share a pool of aircraft across slots. | true |
serverSettings.advanced.allow_sensor_export |
bool | Allow export of sensor data to external tools. | true |
serverSettings.advanced.allow_trial_only_clients |
bool | Allow clients restricted to trial modules to join. | false |
serverSettings.advanced.event_Connect |
bool | Emit connect events to the bot. | true |
serverSettings.advanced.event_Crash |
bool | Emit crash events to the bot. | true |
serverSettings.advanced.event_Ejecting |
bool | Emit ejecting events to the bot. | true |
serverSettings.advanced.event_Kill |
bool | Emit kill events to the bot. | true |
serverSettings.advanced.event_Role |
bool | Emit role-change events to the bot. | true |
serverSettings.advanced.event_Takeoff |
bool | Emit takeoff events to the bot. | true |
serverSettings.advanced.bluePasswordHash |
str | Hashed password to join the blue coalition. (range: min 1) | hash |
serverSettings.advanced.redPasswordHash |
str | Hashed password to join the red coalition. (range: min 1) | hash |
serverSettings.advanced.sav_autosave |
bool | Automatically save the mission state periodically. | true |
discord |
list | Discord roles allowed to use this server. | - '@everyone' |
managed_by |
list | Discord roles allowed to manage this server. | - Special Admin |
channels |
map | Discord channels this server uses for its features. | status: 1122334455667788 |
channels.status |
int | Channel for the server status and player embeds. (range: min -1) | 1122334455667788 |
channels.chat |
int | Channel for the in-game chat replication. (range: min -1) | 8877665544332211 |
channels.events |
int | Channel for game events, split from chat. (range: min -1) | 1928374619283746 |
channels.admin |
int | Channel where admin commands for this server are run. (range: min -1) | 1188227733664455 |
channels.voice |
int | Voice channel players must join when force_voice is on. (range: min -1) | 1827364518273645 |
channels.audit |
int | Server-specific channel for audit events. (range: min -1) | 9182736459182736 |
channels.blue |
int | Channel for the blue coalition chat. (range: min -1) | 1122334455667788 |
channels.blue_events |
int | Channel for blue coalition game events. (range: min -1) | 1122334455667788 |
channels.red |
int | Channel for the red coalition chat. (range: min -1) | 8877665544332211 |
channels.red_events |
int | Channel for red coalition game events. (range: min -1) | 8877665544332211 |
chat_log |
map | In-game chat log written to disk for abuse checks. | count: 10 |
chat_log.count |
int | Number of chat log files kept on disk. (range: min 1) | 10 |
chat_log.size |
int | Maximum size of a chat log file in bytes. | 1048576 |
coalitions |
map | Coalition handling for this server. | lock_time: 15 |
coalitions.lock_time |
str | Minutes a coalition stays locked after joining. (range: min 1) | 15 |
coalitions.allow_players_pool |
bool | Let players switch between unlocked coalitions. | true |
coalitions.blue_role |
text | Discord role mapped to the blue coalition. | Blue |
coalitions.red_role |
text | Discord role mapped to the red coalition. | Red |
no_coalition_chat |
bool | Skip replicating red and blue chats to Discord. | true |