Skip to content

Extension "DCS Olympus"

DCS Olympus is a free and open-source mod for DCS that enables dynamic real-time control through a map interface. It is a mod that needs to be installed into your servers. Best you can do is to download the latest ZIP file from here and provide it to the ModManager service like so:

# config/services/modmanager.yaml
DEFAULT:
  SavedGames: '%USERPROFILE%\Documents\ModManager\SavedGames'
  RootFolder: '%USERPROFILE%\Documents\ModManager\RootFolder'
DCS.dcs_serverrelease:
  packages:
  - name: DCSOlympus
    version: latest
    source: SavedGames
    # uncomment for auto-update:
    # repo: https://github.com/Pax1601/DCSOlympus
To use the DCS Olympus client, you need Node.js installed. Click on the link, download and install it. Remember the installation location, as you need to provide it in the configuration.

Warning

Do NOT install Chocolatey, it is unnecessary for Olympus, and it seems to create issues with Python installations.

Configuration

Then you can add the DCS Olympus extension like so to your nodes.yaml:

Version 1.0.4 or higher

# config/nodes.yaml
MyNode:
  # [...]
  extensions:
    Olympus:
      nodejs: '%ProgramFiles%\nodejs'
      autoupdate: true                  # Optional: autoupdate DCS Olympus (needs ModManager activated, default: false)
      auto_affinity:                    # Optional: affinity settings
        min_cores: 1                    # Min cores to be used by node.js (default: 1)
        max_cores: 1                    # Max cores to be used by node.js (default: 1)
        quality: 1                      # Core quality (0 = low (E-cores), 1 = normal, 2 = high, default: 1)
  # [...]
  instances:
    DCS.dcs_serverrelease:
      # [...]
      extensions:
        Olympus:
          debug: true                     # Show the Olympus console in the DCSSB console, default = false
          show_passwords: true            # show passwords in your server status embed (default: false)
          url: http://myfancyurl:3000/    # optional: your own URL, if available
          backend:
            port: 4512                    # server port for DCS Olympus internal communication (needs to be unique)                   
          authentication:
            gameMasterPassword: secret    # Game Master password
            blueCommanderPassword: blue   # Blue Tactical Commander password
            redCommanderPassword: red     # Red Tactical Commander password
            adminPassword: admin          # Admin Password (Olympus 2.0)
          frontend:
            path: '%USERPROFILE%\Saved Games\Olympus\frontend' # Optional: path to the Olympus frontend. This is only needed if you are using the official installer. ModManager users don't need this.
            port: 3000                    # Port where DCS Olympus listens for client access (needs to be unique)
            # customAuthHeaders:          # SSO configuration (Olympus 2.0), see Olympus documentation
            #   ...
            # elevationProvider:          # Elevation data provider (Olympus 2.0), see Olympus documentation
            #   ...
            # mapLayers:                  # Providers for map displays (Olympus 2.0), see Olympus documemtation
            #   ...
            # mapMirrors:                 # Map tiles sources (Olympus 2.0), see Olympus documentation
            #   ...
          audio:                          # SRS audio settings (Olympus 2.0)
            WSPort: 4000                  # The WSPort is the port used by the web interface to connect to the audio backend WebSocket. It should be available and not used by other processes.
            WSEndpoint: audio             # The WSEndpoint is the endpoint used by the web interface to connect to the audio backend WebSocket when using a reverse proxy. A websocket proxy should be set up to forward requests from this endpoint to WSPort.
    instance2:                            # Optional: the configuration of other instances would be added here
      # [...]
      extensions:
        Olympus:
          enabled: false                  # Don't enable DCS Olympus on your instance2

Important

You need to forward the frontend port from your router to the PC running DCS and DCS Olympus.

Version 1.0.3 (deprecated)

# config/nodes.yaml
MyNode:
  # [...]
  extensions:
    Olympus:
      nodejs: '%ProgramFiles%\nodejs'
  # [...]
  instances:
    DCS.dcs_serverrelease:
      # [...]
      extensions:
        Olympus:
          debug: true                     # Show the Olympus console in the DCSSB console, default = false
          show_passwords: true            # show passwords in your server status embed (default: false)
          url: http://myfancyurl:3000/    # optional: your own URL, if available
          server:
            address: '*'                  # your bind address. * = 0.0.0.0, use localhost for local only setups
            port: 3001                    # server port for DCS Olympus internal communication (needs to be unique)                   
          authentication:
            gameMasterPassword: secret    # Game Master password
            blueCommanderPassword: blue   # Blue Tactical Commander password
            redCommanderPassword: red     # Red Tactical Commander password
          client:
            port: 3000                    # Port where DCS Olympus listens for client access (needs to be unique)
    instance2:
      # [...]
      extensions:
        Olympus:
          enabled: false                  # Don't enable DCS Olympus on your instance2

Important

You need to forward the server port and the client port from your router to the PC running DCS and DCS Olympus.
To create an exclusion in your UAC run this: netsh http add urlacl url="http://*:3001/olympus/" user=user-running-dcs

Tip

You can rename the Olympus extension in your server status embed by setting a "name" in the configuration like so:

extension:
  Olympus:
    name: MyFancyName  # Optional: default is "DCS Olympus"


Configuration reference

Key Type Description Example
enabled bool Whether this extension is enabled on this node. true
name str Name shown for the Olympus extension in the server status embed. (range: min 1) DCS Olympus
nodejs str Path to your Node.js installation. (range: min 1) %ProgramFiles%\nodejs
autoupdate bool Auto-update DCS Olympus when a new version is available online. true
debug bool Show the Olympus console output in the bot console. false
show_passwords bool Show the Olympus passwords in the server status embed. true
authentication map Passwords that guard the Olympus roles. gameMasterPassword: ''
blueCommanderPassword: '
'
redCommanderPassword: '***'
auto_affinity map CPU affinity applied to the Olympus Node.js process. min_cores: 1
max_cores: 1
quality: 1
enabled bool Whether the Olympus extension is enabled on this instance. true
autoupdate bool Auto-update DCS Olympus on this instance when a new version is available. true
name str Name shown for the Olympus extension in the server status embed. (range: min 1) DCS Olympus
debug bool Show the Olympus console output in the bot console. false
show_passwords bool Show the Olympus passwords in the server status embed. true
url url Public URL of the Olympus frontend, if you have one. http://myfancyurl:3000/
auto_affinity map CPU affinity applied to the Olympus Node.js process. min_cores: 1
max_cores: 1
quality: 1
<(backend\|server)> map (required)
authentication map Passwords that guard the Olympus roles. gameMasterPassword: ''
blueCommanderPassword: '
'
redCommanderPassword: ''
adminPassword: '
'
<(frontend\|client)> map (required)
audio map SRS audio settings for the Olympus web client (Olympus 2.0). WSPort: 4000
WSEndpoint: audio

node_olympus

Key Type Description Example
authentication.gameMasterPassword str (required) Password for the Game Master role. (range: min 1) ***
authentication.blueCommanderPassword str (required) Password for the Blue Tactical Commander role. (range: min 1) ***
authentication.redCommanderPassword str (required) Password for the Red Tactical Commander role. (range: min 1) ***
authentication.adminPassword str Admin password (Olympus 2.0 and later). (range: min 1) ***
auto_affinity.min_cores int Minimum number of cores reserved for Node.js. (range: min 1, max 2) 1
auto_affinity.max_cores int Maximum number of cores reserved for Node.js. (range: min 1, max 2) 1
auto_affinity.quality int Core quality to prefer (0 = E-cores, 1 = normal, 2 = high). (range: min 0, max 2) 1

instance_olympus

One entry per name, keyed by that name (<(backend|server)>).

Key Type Description Example
ores int Minimum number of cores reserved for Node.js. (range: min 1, max 2) 1
ores int Maximum number of cores reserved for Node.js. (range: min 1, max 2) 1
ty int Core quality to prefer (0 = E-cores, 1 = normal, 2 = high). (range: min 0, max 2) 1
address str Bind address for the Olympus backend service. (range: min 1) localhost
port int Unique TCP port for Olympus internal communication. 4512
MasterPassword str (required) Password for the Game Master role. (range: min 1) ***
CommanderPassword str (required) Password for the Blue Tactical Commander role. (range: min 1) ***
ommanderPassword str (required) Password for the Red Tactical Commander role. (range: min 1) ***
nPassword str Admin password (Olympus 2.0 and later). (range: min 1) ***
.path str Path to the Olympus frontend installation. (range: min 1) %USERPROFILE%\Saved Games\Olympus\frontend
.port int Unique TCP port the Olympus web client connects to. 3000
.customAuthHeaders map Single sign-on header configuration (Olympus 2.0). enabled: true
username: olympus
group: admin
.customAuthHeaders.enabled bool Enable custom authentication headers. true
.customAuthHeaders.username str Username sent in the authentication header. (range: min 1) olympus
.customAuthHeaders.group str Group sent in the authentication header. (range: min 1) admin
.elevationProvider map Terrain elevation data provider (Olympus 2.0). provider: https://srtm.fasma.org/{lat}{lng}.SRTMGL3S.hgt.zip
username: srtmuser
password: '***'
.elevationProvider.provider url URL template of the elevation data source. https://srtm.fasma.org/{lat}{lng}.SRTMGL3S.hgt.zip
.elevationProvider.username str Username for the elevation provider, if required. srtmuser
.elevationProvider.password str Password for the elevation provider, if required. ***
.mapLayers map Additional map layer providers (Olympus 2.0). Topo:
urlTemplate: https://tiles.example.com/{z}/{x}/{y}.png
.mapLayers.<(.+)> map
.mapLayers.<(.+)>.urlTemplate url URL template of this map layer's tiles. https://tiles.example.com/{z}/{x}/{y}.png
.mapLayers.<(.+)>.minZoom int Lowest zoom level this map layer is shown at. (range: min 1) 1
.mapLayers.<(.+)>.maxZoom int Highest zoom level this map layer is shown at. (range: max 100) 18
.mapLayers.<(.+)>.attribution str Attribution text displayed on this map layer. (range: min 1) © OpenStreetMap
.mapMirrors map Alternative map tile sources (Olympus 2.0). Topo: https://mirror.example.com/{z}/{x}/{y}.png
.mapMirrors.<(.+)> url
.autoconnectWhenLocal bool Auto-connect the client when it runs on the same host. true
.proxyHeader str HTTP header used to detect the client behind a proxy. (range: min 1) X-Forwarded-For
`` int Obsolete: the SRS port is filled in from the SRS extension. 5002
`` int Port of the Olympus audio backend WebSocket. 4000
`` str WebSocket endpoint exposed through a reverse proxy. (range: min 1) audio