-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathconfig.yaml
202 lines (191 loc) · 8.34 KB
/
config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# Sample YAML configuration file for SkyEye.
# New to YAML? Here's a crash course.
#
# Comments:
# - Comments are lines that start with the '#' symbol. Comments are ignored
# when the config file is loaded.
# - You'll need to uncomment the example configuration values if you want to
# customize them. You can do this by deleting the '#' at the start of that
# line.
#
# Setting configuration values:
# - A key is a unique identifier, followed by a colon and a space, and then the
# value.
# - Values can be strings (text), booleans (true/false), numbers, or lists of
# strings.
# - Strings can be enclosed in quotes to disambiguate them if needed.
# - Some values are time intervals. You can specify "m" for minutes and "s" for
# seconds. For example, "90s" and "1m30s" are both 90 seconds.
# - You can check the defaults by passing the --help flag to the executable.
#
# Learn more: https://learnxinyminutes.com/docs/yaml/
# SPEECH RECOGNITION
#
# Choose "openai-whisper-local" to use local speech recognition, which has
# more intense system requirements.
# Choose "openai-whisper-api" to use the OpenAI API for speech recognition,
# which requires paying OpenAI for credits.
# See docs/ADMIN.md for more details and advantages and disadvantages of each.
#recognizer: openai-whisper-local
#
# If you chose local speech recogntion, SkyEye requires a whisper.cpp model from
# https://huggingface.co/ggerganov/whisper.cpp/tree/main. Note that the
# cloud-init and WinSW YAML files provided with the release will download the
# model on your behalf before starting SkyEye. You probably only need to change
# the value of whisper-model here if you're manually installing SkyEye or
# are running a development build.
#
# The small English-only model provides a good balance between performance, RAM
# usage and quality.
#whisper-model: ggml-small.en.bin
#
# The medium English-only model has better quality, but requires a powerful CPU
# and additional RAM.
#whisper-model: ggml-medium.en.bin
#
# Only resort to the tiny model if the small model is too slow. It has poor
# speech recognition quality.
#whisper-model: ggml-tiny.en.bin
#
# If you chose the OpenAI API for cloud-based speech recognition, you need to
# provide an API key. You can get an API key at https://openai.com/api.
#openai-api-key: apikeygoeshere
# TELEMETRY
# Telemetry service address. Set this to the host and port of the TacView
# real-time telemetry service for your DCS World installation.
# DCS running on the same computer:
#telemetry-address: localhost:42674
# DCS running remotely:
#telemetry-address: dcs.example.com:42674
#
# If your telemetry is password-protected, set the password here.
#telemetry-password: passwordgoeshere
# SIMPLERADIO-STANDALONE
# SRS server address. Set this to the host and port of the SRS server.
# SRS server running on the same computer:
#srs-server-address: localhost:5002
# SRS server running remotely:
#srs-server-address: srs.example.com:5002
#
# SRS EAM password. Set this to the password used to connect to External AWACS
# Mode in SRS.
#srs-eam-password: eampasswordgoeshere
#
# SRS frequencies. Set this to the radio frequencies the GCI should listen and
# speak on. The GCI can understand players speaking simultaneously on multiple
# frequencies. It speaks on all frequencies simultaneously, similar to the
# Simultaneous Tranmission (ST) option in the official SRS client application.
#
# ⚠️ Consider that some aircraft are limited to certain frequencies. For example,
# the F-4E can only tune 225.0AM-399.95AM on the primary radio and 265.0AM-284.9AM
# on the aux radio. Meanwhile, the F-16 can only tune 225.000-399.975 on COM1 and
# 108.000-151.975 on COM2.
#srs-frequencies: 251.0AM,133.0AM,30.0FM
# DCS-gRPC (optional)
# Enable DCS-gRPC features (requires https://github.com/DCS-gRPC/rust-server)
# This enables using in-game chat to communicate with the GCI.
#enable-grpc: true
# Address of the DCS-gRPC server (usually port 50051 on the DCS World server)
# DCS running on the same computer:
#grpc-address: localhost:50051
# DCS running remotely:
#grpc-address: dcs.example.com:50051
#
# If authentication is enabled on the DCS-gRPC server, set the API key here.
# Authentication is STORNGLY RECOMMENDED if the DCS-gRPC server is exposed over
# a network, as it allows powerful control over the DCS World server and mission.
#grpc-password: passwordgoeshere
# IDENTITY
# Set the callsign to whatever you want the GCI to use as the callsign. Good
# callsigns should be in English, two or three syllables, and easy to
# pronounce. Real-world examples include: Baron, Chalice, Darkstar, Disco,
# Focus, Goliath, Magic, Sentry and Wizard. If you don't provide a callsign, a
# random callsign is selected from a set of Ace Combat/Project Wingman easter
# eggs.
#
# ⚠️ Please do _not_ use the callsign "Overlord" to avoid any possible
# confusion with OverlordBot. I do not want any confused players to send bug
# reports to the wrong project!
#callsign: Focus
# Alternatively you can provide a list of callsigns and one will be randomly
# selected.
#callsigns: [Wizard, Magic, Goliath]
#
# Set the coalition this GCI will serve - either "red" or "blue"
#coalition: blue
# SPEECH SYNTHESIS
# Select a voice (either feminine or masculine). If you don't select one, one
# is selected for you.
#voice: feminine
#
# Set the playback speed of the voice. Values below 1.0 speed up the voice,
# while values below 1.0 speed it up.
#voice-playback-speed: 1.0
#
# Customize the length of the pause between sentences. This can be useful if
# the GCI is speaking too quickly for your taste.
#voice-playback-pause: 0.3s
# BEHAVIOR
# By default, the GCI broadcasts an updated PICTURE if a PICTURE has not been
# given for two minutes. I find this feature works very well for smaller
# missions like Retribution campaigns, where the PICTURE helps maintain
# situational awareness. However, I understand that on a large server with lots
# of enemy aircraft this could become annoying, so the feature is customizable.
#
# You can disable PICTURE broadcasts by setting auto-picture to false. Players
# may still request a PICTURE on demand, but automatic broadcasts will be
# disabled.
#auto-picture: true
#
# You can customize the PICTURE broadcast interval. I find values between 2 and
# 5 minutes work best.
#auto-picture-interval: 2m
#
# By default, the GCI monitors any friendly aircraft which tunes onto any of the
# configured SRS frequencies. The GCI will broadcast a threat call if a hostile
# aircraft approaches close enough to a monitored friendly aircraft to satisfy
# threat criteria. Threat criteria are dynamic; for example, a Su-27 Flanker is
# considered to be a threat at a greater range than a Su-17 Fitter.
#
# You can disable threat monitoring by setting threat-monitoring to false. I
# don't recommend this because it greatly reduces situational awareness. But
# hey, it's your video game and I'm not your dad.
#threat-monitoring: true
#
# Threat calls are repeated if the threat criteria are still met after a
# cooldown period. You can customize how often the bot rebroadcasts threat
# calls.
#threat-monitoring-interval: 3m
#
# At a close enough range, any hostile aircraft with air-to-air capabilities is
# considred a threat regardless of its platform. The default value (25 nautical
# miles) is a reasonable choice for a modern setting, but you may wish to tune
# this based on mission requirements and player skill level.
#mandatory-threat-radius: 25
# LOGGING
#
# Log verbosity. Most should leave this at the default INFO level, unless
# troubleshooting an issue.
#log-level: info
#
# Log format. "pretty" is easier to read in a console, "json" is easier to
# search/query later.
#log-format: pretty
# TRACING
#
# Enable or diable tracing.
#enable-tracing: false
#
# Send traces to Discord by providing a webhook ID and token.
# The format of the webhook URL is https://discord.com/api/webhooks/<id>/<token>
#discord-webhook-id: idgoeshere
#discord-webhook-token: tokengoeshere
# RUNTIME
#
# Limit the maximum bot runtime. This is useful in combination with systemd or
# WinSW to restart the bot periodically. I've made a best effort to ensure the bot
# is stable over long periods of time, but it's always possible that a resource
# leak or other issue could cause the bot to break after running for a very long
# time. It may be prudent to restart the bot every few days. The bot won't exit
# if there are humans on any configured SRS channels, until they leave.
#exit-after: 72h