Plugin “Mission”

The mission plugin adds commands for amending the mission list, persistent mission- and player-embeds to be displayed in your status channels and ATIS like information for the missions’ airports.

User Linking

It is recommended that your users link their Discord ID to their UCID (DCS World ID). The bot can try to do that by itself (bot.yaml: automatch: true), but might fail, especially, when the in-game names and Discord names of users differ a lot.

[!NOTE] Users can generate a unique TOKEN that is being sent as a DM with the /linkme command.
The TOKEN can then be entered in the in-game chat as a chat-command with -linkme TOKEN.

Uploading of Missions

You can upload .miz files in the configured admin channel of your server(s). Existing missions will be replaced (with security question) and if the server is running with that mission, it will be restarted (another security question will apply). Newly added missions will be auto-added to the mission list.

Custom User Menus

DCSServerBot allows you to create custom user menus, that people can use via the F10 menu. The default usecase is to call chat commands with them.
To configure the menu, you need to create a file “config/menus.yaml” in your configuration directory like so:

DEFAULT:
  - DCSServerBot:                   # This is the name of the F10-Root menu (multiple possible)
      - Help:                       # Top-Level command below the root menu
          command: onChatCommand
          subcommand: help          # Call the "help" chat-command
      - GameMaster:                 # Sub-menu section
        - Launch AWACS:             # Command inside of the subsection
            command: onChatCommand
            subcommand: flag        # Call the chat-command "flag 1 1", which sets flag 1 to value 1
            params: [ 1, 1 ]
        - Disable Punishments:      # Call a game event "disablePunishments"
            command: disablePunishments
            discord:                # This menu option will only be available for the DCS Admin role
              - DCS Admin
        - Start Campaign:
            command: startCampaign  # Call a game event "startCampaign" 
            ucid:                   # This command will only be available for this UCID
              - aabbccddeeffgghhiijjkkllmmnnoopp
        - Stop Campaign:
            command: stopCampaign
            ucid:
              - aabbccddeeffgghhiijjkkllmmnnoopp
      - Weather:
        - Morning:
            command: onChatCommand
            subcommand: preset      # Select the preset "Morning" (needs to exist!)
            params: [ 'Morning' ]
        - Night:
            command: onChatCommand
            subcommand: preset      # Select the preset "Night" (needs to exist!)
            params: [ 'Night' ]
        - RealWeather:
            command: onChatCommand
            subcommand: realweather # Run "DCS RealWeather" with a specified airport
            params: ['UGKO']

[!NOTE] DCS World can only create menus for groups. This means, that you should create groups that contain single units only, especially, if you use commands that can only be called by specific roles.

Roles are checked twice though: once, when the menu gets created. You should not see any command, that your role can not use. A second check is done, when the command is being executed (onChatCommand only).

Configuration

You can configure the behaviour of the mission plugin with an optional config/plugins/mission.yaml:

DEFAULT:
  event_filter:       # do NOT report these events (default: [])
    - connect
    - disconnect
    - change_slot
    - friendly_fire
    - self_kill
    - kill
    - takeoff
    - landing
    - crash
    - eject
    - pilot_death
    - shot
    - hit
  uploads:                      # Configure how mission uploads are handled
    enabled: true               # Here you can disable the feature at all (default: true = enabled)
    channel: 112233445566778899 # Optional: mission upload channel (default: admin channel)
    discord:
      - DCS Admin               # Define which roles are allowed to upload missions (default: DCS Admin)

Auto-Scanning

If you set autoscan: true in your server configuration of your servers.yaml, all miz files that were added into the Missions folder of your DCS-server (for instance via a Google Drive) will be auto-added to your mission list.

Discord Commands

In-Game Chat Commands

Tables

Players

Players_Hist

This table keeps a history of all changes to the main player table.

Column	Type	Description
#id	NUMBER	Unique ID (sequence)
ucid	TEXT	Unique ID of this user (DCS ID).
discord_id	BIGINT	Discord ID of this user (if matched) or -1 otherwise.
name	TEXT	Last used DCS in-game-name of this user.
ipaddr	TEXT	Last used IP-address of this user.
coalition	TEXT	The coalition the user belongs to.
manual	BOOLEAN	True if this user was manually matched, FALSE otherwise.
time	TIMESTAMP DEFAULT NOW()	Time of the change.

Missions