Skip to content

Extension "SkyEye"

SkyEye is an AI-powered GCI bot for DCS World, to which you can talk to using SRS. The solution comes with a server that connects to SRS and gRPC and (optional) Tacview.

Installation

Download the latest release version of SkyEye from here. You most likely want the skyeye-windows-amd64.zip. Unzip the file to a directory of your choice. This will be called the "installation directory" further on.

Note

Please keep in mind that the bot needs to write permissions to this directory to download the whisper model and for auto-updating of SkyEye.

Configuration

Then you can configure the SkyEye extension in your nodes.yaml like so:

# config/nodes.yaml
MyNode:
  # [...]
  extensions:
    SkyEye:
      installation: '%USERPROFILE%\Documents\skyeye-windows-amd64'  # or wherever you have installed it
      autoupdate: true                                              # Auto update SkyEye, whenever a new version is available
      auto_affinity:                                                # Optional: set core affinity
        min_cores: 2                                                # Min cores to be used (default: 2)
#        max_cores: 4                                               # Max cores to be used (default: unlimited)
        quality: 2                                                  # Core quality (0 = low (E-cores), 1 = normal, 2 = high, default: 2)
  # [...]
  instances:
    DCS.dcs_serverrelease:
      extensions:
        SkyEye:
          debug: true                   # Replicate the SkyEye console log into the DCSSB log
          log: {instance.home}/Logs/skyeye.log        # Replicate the SkyEye log into a separate logfile
          config: {instance.home}/Config/SkyEye.yaml' # your SkyEye config file (default path)
          coalition: blue               # Which coalition should SkyEye be active on   
          any-other-skyeye-config: xxx  # See the SkyEye documentation. 
          # No need to provide SRS, Tacview and gRPC configuration, as long as they are configured in nodes.yaml

Note

It is recommended to have your SkyEye configuration in your instance-specific Saved Games\instance\Config directory, as that allows the auto-detection of the process and is a clean way of having all your instance configurations at one place.

Tip

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

extension:
  SkyEye:
    name: MyFancyName  # Optional: default is "SkyEye"

Note

DCSServerBot uses the local Whisper model per default, if not configured otherwise. If you see performance issues, try the (paid) API version instead.

Important

SkyEye can be very heavy on your CPU if you use local (free) whisper models. The recommended way of running it is to use the external model with an API key. If you still decide to run SkyEye locally, it is recommended to separate SkyEye from your running DCS servers. You can use the affinity setting in your instance configuration (see above) and in the SkyEye configuration to separate the cores from each other.

Optional: Multiple SkyEye configurations per server (for red/blue, multiple AWACS, etc.)

# config/nodes.yaml
MyNode:
  # [...]
  extensions:
    SkyEye:
      installation: '%USERPROFILE%\Documents\skyeye-windows-amd64'  # or wherever you have installed it
  # [...]
  instances:
    DCS.dcs_serverrelease:
      affinity: 1, 2                  # Recommended, set core affinity for your DCS server process when using SkyEye
      # [...]
      extensions:
        SkyEye:
          debug: true                   # Replicate the SkyEye console log into the DCSSB log
          log: '{instance.home}\Logs\skyeye-{coalition}.log'        # Replicate the SkyEye log into a separate logfile
          config: '{instance.home}\Config\SkyEye-{coalition}.yaml'  # your SkyEye config file (default path)
          instances:                      # configure multiple SkyEye instances
          - coalition: blue               # Which coalition should SkyEye be active on   
            affinity: 12,13               # Set the core affinity for SkyEye (recommended!)
            any-other-skyeye-config: xxx  # See the SkyEye documentation. 
          - coalition: red
            affinity: 14,15               # Set the core affinity for SkyEye (recommended!)
            any-other-skyeye-config: xxx  # See the SkyEye documentation. 

[!NOTE] Please make sure that your log and config pathes are unique over all your SkyEye instances. If you use several SkyEye instances per coalition, rename them to maybe SkyEye-{coalition}-1.log, ...-2.log, ...-3.log.

Optional: Remote SkyEye installations

If you want to use a SkyEye installation that is not installed on the same machine as your DCS server, you can use the "remote" configuration option:

# config/nodes.yaml
MyNode:
  # [...]
  instances:
    DCS.dcs_serverrelease:
      extensions:
        SkyEye:
          enabled: true
          remote: true                    # there is no running SkyEye instance on this machine
          version: 1.9.1                  # as we can not read the version, you are happy to provide it here
          instances:                      # configure single or multiple SkyEye instances, see above (informational only here)
          - coalition: blue               # Which coalition should SkyEye be active on   
            affinity: 12,13               # Set the core affinity for SkyEye (recommended!)
            any-other-skyeye-config: xxx  # See the SkyEye documentation. 
          - coalition: red
            affinity: 14,15               # Set the core affinity for SkyEye (recommended!)
            any-other-skyeye-config: xxx  # See the SkyEye documentation. 


Configuration reference

Key Type Description Example
enabled bool Whether this extension is enabled on this node. true
name str Name of the SkyEye extension in status embeds. (range: min 1) SkyEye
installation str (required) Directory where SkyEye is installed. (range: min 1) %USERPROFILE%\Documents\skyeye-windows-amd64
autoupdate bool Update SkyEye automatically on new releases. true
debug bool Replicate the SkyEye console log into the bot log. false
auto_affinity map Core affinity assigned to the SkyEye process. min_cores: 2
max_cores: 4
quality: 2
enabled bool Enable the SkyEye extension for this instance. true
name str Name of the SkyEye extension in status embeds. (range: min 1) SkyEye
debug bool Replicate the SkyEye console log into the bot log. false
remote bool SkyEye runs on a different machine than this node. false
version str SkyEye version, needed when it runs remotely. (range: min 1) 1.9.1
log str File the SkyEye log is replicated to. (range: min 1) {instance.home}\Logs\skyeye.log
affinity any Pinned CPU cores for SkyEye (deprecated). 12,13
config str Path to your SkyEye configuration file. (range: min 1) {instance.home}\Config\SkyEye.yaml
coalition str Coalition SkyEye is active on. (one of: blue, red) blue
recognizer str Speech recognizer used by SkyEye. (one of: openai-whisper-local, openai-whisper-api) openai-whisper-local
whisper-model str Whisper model used by the local recognizer. (range: min 1) ggml-small.en.bin
openai-api-key str API key for the OpenAI Whisper API recognizer. (range: min 1) ***
callsign str Callsign SkyEye answers to. (range: min 1) Magic
callsigns list Callsigns SkyEye rotates through. - Magic
- Focus
voice str Voice SkyEye uses for spoken messages. (one of: feminine, masculine) feminine
voice-playback-speed float Playback speed of the SkyEye voice. 1.0
voice-playback-pause str Pause played after each spoken sentence. 1s
auto-picture bool Post an automatic picture at regular intervals. false
auto-picture-interval str Interval between automatic pictures. 15m
threat-monitoring bool Announce airborne threats to the players. true
threat-monitoring-interval str Interval between threat checks. 2m
mandatory-threat-radius int Radius in nautical miles that always counts as a threat. 40
discord-webhook-id text Discord webhook id SkyEye posts alerts to. 112233445566778899
discord-webhook-token str Discord webhook token for those alerts. (range: min 1) ***
telemetry-address str Tacview telemetry address, set automatically (deprecated). (range: min 1) localhost:42674
telemetry-password str Tacview telemetry password, set automatically (deprecated). ***
srs-server-address str SRS server address, set automatically (deprecated). (range: min 1) localhost:5002
srs-eam-password str SRS external AWACS password, set automatically (deprecated). (range: min 1) ***
srs-frequencies str SRS frequencies SkyEye broadcasts on. 251.0AM,133.0AM,30.0FM
enable-grpc bool Enable the DCS gRPC link (deprecated). false
grpc-address str DCS gRPC address, set automatically (deprecated). (range: min 1) localhost:50051
grpc-password str DCS gRPC password, set automatically (deprecated). (range: min 1) ***
instances list One entry per SkyEye instance, e.g. per coalition. - coalition: blue
affinity: 12,13
- coalition: red
affinity: 14,15
enabled bool Enable the SkyEye extension for this instance. true
name str Name of the SkyEye extension in status embeds. (range: min 1) SkyEye
debug bool Replicate the SkyEye console log into the bot log. false
remote bool SkyEye runs on a different machine than this node. false
version str SkyEye version, needed when it runs remotely. (range: min 1) 1.9.1
log str File the SkyEye log is replicated to. (range: min 1) {instance.home}\Logs\skyeye.log
affinity any Pinned CPU cores for SkyEye (deprecated). 12,13
config str Path to your SkyEye configuration file. (range: min 1) {instance.home}\Config\SkyEye.yaml
coalition str Coalition SkyEye is active on. (one of: blue, red) blue
recognizer str Speech recognizer used by SkyEye. (one of: openai-whisper-local, openai-whisper-api) openai-whisper-local
whisper-model str Whisper model used by the local recognizer. (range: min 1) ggml-small.en.bin
openai-api-key str API key for the OpenAI Whisper API recognizer. (range: min 1) ***
callsign str Callsign SkyEye answers to. (range: min 1) Magic
callsigns list Callsigns SkyEye rotates through. - Magic
- Focus
voice str Voice SkyEye uses for spoken messages. (one of: feminine, masculine) feminine
voice-playback-speed float Playback speed of the SkyEye voice. 1.0
voice-playback-pause str Pause played after each spoken sentence. 1s
auto-picture bool Post an automatic picture at regular intervals. false
auto-picture-interval str Interval between automatic pictures. 15m
threat-monitoring bool Announce airborne threats to the players. true
threat-monitoring-interval str Interval between threat checks. 2m
mandatory-threat-radius int Radius in nautical miles that always counts as a threat. 40
discord-webhook-id text Discord webhook id SkyEye posts alerts to. 112233445566778899
discord-webhook-token str Discord webhook token for those alerts. (range: min 1) ***
telemetry-address str Tacview telemetry address, set automatically (deprecated). (range: min 1) localhost:42674
telemetry-password str Tacview telemetry password, set automatically (deprecated). ***
srs-server-address str SRS server address, set automatically (deprecated). (range: min 1) localhost:5002
srs-eam-password str SRS external AWACS password, set automatically (deprecated). (range: min 1) ***
srs-frequencies str SRS frequencies SkyEye broadcasts on. 251.0AM,133.0AM,30.0FM
enable-grpc bool Enable the DCS gRPC link (deprecated). false
grpc-address str DCS gRPC address, set automatically (deprecated). (range: min 1) localhost:50051
grpc-password str DCS gRPC password, set automatically (deprecated). (range: min 1) ***
instances list One entry per SkyEye instance, e.g. per coalition. - coalition: blue
affinity: 12,13
- coalition: red
affinity: 14,15

node_skyeye

Key Type Description Example
auto_affinity.min_cores int Minimum number of CPU cores to assign. (range: min 2, max 4) 2
auto_affinity.max_cores int Maximum number of CPU cores to assign. (range: min 2) 4
auto_affinity.quality int Core quality to prefer (0=E, 1=normal, 2=high). (range: min 0, max 2) 2