Configuration
SA uses convars for config values. For information on how to correctly install the config.cfg
file, see here.
Value List
Name | Default Value |
---|---|
ic_sa_kickCheaters | false |
ic_sa_secondsTillDoorsClose | 150 |
ic_sa_secondsTillLightsReset | 150 |
ic_sa_tones | See Below |
ic_sa_enableAddon | false |
ic_sa_addonPaymentReference | "" |
ic_sa_ttsLanguage | en-us |
ic_sa_ttsVoice | Mary |
is_sa_ttsSpeechRate | -1 |
ic_sa_followUpAlertMessages | true |
ic_sa_repeatMessage | true |
ic_sa_endingTone | true |
ic_sa_manualInteractions | false |
ic_sa_slowerDoors | `true |
ic_sa_wallLightModels | See Below |
ic_sa_trafficLightModels | See Below |
ic_sa_unitIndicatorModels | See Below |
ic_sa_doorControlsModel | prop_ic_door_controls |
ic_sa_ceilingSpeakerModel | v_serv_metro_ceilingspeaker |
ic_sa_httpAccessToken | "" |
ic_sa_whitelistedIps | See Below |
ic_sa_debug | false |
Values Explained
Kick Cheaters
ic_sa_kickCheaters
If this value is true
, the resource will kick any players it detects as "cheaters". Cheaters are determined by events sent to the server, and actions performed. False-positive as possible, but unlikely.
Regardless of this value, the resource will log events in the server console whenever it believes it has found a cheater.
Seconds Till Doors Close
ic_sa_secondsTillDoorsClose
This must be a whole number, more than or equal to -1
. Suggested value range: 140
- 160
.
This is the number of seconds after an Alert is activated, that any doors that were opened are automatically closed.
If value is -1
, doors will stay open until manually closed.
Seconds Till Lights Reset
ic_sa_secondsTillLightsReset
This must be a whole number, more than 0. Suggested value range: 125
- 150
.
This is the number of seconds after an Alert is activated, that Wall Lights and Unit Indicators will reset.
Alert Tone Sounds
ic_sa_tones
These values define what tones can be played. Each entry contains "human-readable name", and a "file name".
The human-readable name can be anything, but the file name must be the name of the sound file including the file extension.
Audio files must be placed inside the ui/assets
folder.
Tones can be any length and any audio file extension.
Tones can also not be tones, but re-recorded turnout messages; for example, one tone for each type of appliance.
The default value for this option is:
setr ic_sa_tones {
"Tone 1": "alert1.mp3",
"Tone 2": "alert2.mp3",
"Tone 3": "alert3.mp3"
}
Manual Interactions (Target/Third-Eye Resource Support)
ic_sa_manualInteractions
If this value is true
, "Press E ..." interaction pop-ups and keybindings will be disabled, and instead events will be fired that can be used in editable/client/targeting.lua
; to enable support for OxTarget, QBTarget, or any other target/third-eye resource, changes will need to be made in this file.
For OxTarget or QBTarget, simply uncomment the lines under the sections named either OxTarget or QBTarget.
For any other target/third-eye resource, use the provided event handlers and variables to add your own exports/events. Reach out in Discord if you need help adding other resources.
The events in editable/client/targeting.lua
will not fire unless ic_sa_manualInteractions
is true
.
Slower Doors
ic_sa_slowerDoors
When this value is true
, doors will open and closer slower than normal to be more realistic.
If you do not want the resource to change the speed of the doors, set this value to false
.
If this value is true
and your doors do not open like they should, or need to be bumped/hit to be open, change this value to false
and it should resolve the issue.
HTTP Access Token
ic_sa_httpAccessToken
This is an optional config value that is required if server owners wish to use the included API.
This value is blank by default, and while blank, the API will reject all HTTP requests.
To enable the API you must provide a value to be used as a token.
API Whitelist
ic_sa_whitelistedIps
This is an optional config value that allows server owners to only allow HTTP requests from specific IP addresses.
To allow to requests from any IP address, set this value to []
.
The default value, 127.0.0.1
, should allow access from the local machine only on most systems.
Regardless of this config option, ic_sa_httpAccessToken
is required.
Default Wall Light Models
ic_sa_wallLightModels
These values determine which prop/model should be used for de/activated Wall Lights.
The default value for this option is:
setr ic_sa_wallLightModels {
"off": "hei_prop_wall_alarm_off",
"on": "prop_ic_wall_light"
}
Default Traffic Light Models
ic_sa_trafficLightModels
These values determine which prop/model should be used for Traffic Lights.
The default value for this option is:
setr ic_sa_trafficLightModels {
"Red": "prop_ic_traffic_light_r",
"Yellow": "prop_ic_traffic_light_y",
"Green": "prop_ic_traffic_light_g"
}
Default Unit Indicator Models
ic_sa_unitIndicatorModels
These values determine which prop/model should be used for Unit Indicators.
The default value for this option is:
setr ic_sa_trafficLightModels {
"None": "prop_ic_unit_indicator",
"Red": "prop_ic_unit_indicator_r",
"Green": "prop_ic_unit_indicator_g",
"Blue": "prop_ic_unit_indicator_b"
}
Default Door Controls Model
ic_sa_doorControlsModel
These values determine which prop/model should be used for Door Controls.
The default value for this option is:
setr ic_sa_doorControlsModel "prop_ic_door_controls"
Default Ceiling Speaker Model
ic_sa_ceilingSpeakerModel
These values determine which prop/model should be used for Ceiling Speakers.
The default value for this option is:
setr ic_sa_ceilingSpeakerModel "v_serv_metro_ceilingspeaker"
Debug
ic_sa_debug
If this value is true
, a ton of extra logs will be outputted to both the client and server consoles. Not suggested at all for production use, nor for when using the SA Tool.
Voice Turnout Addon Values Explained
The Voice Turnout Addon is an optional, subscription based, addon for SA.
You can purchase it from our Tebex Store here.
The options below require a valid subscription, or they will not work.
Enable Voice Turnout Addon
ic_sa_enableAddon
This value must be set to true
to enable to Text-to-Speech features of SA.
Default value is false
; changing to true
without a valid subscription will result in an error.
Tebex Subscription Payment Reference
ic_sa_addonPaymentReference
This value is the Subscription specific Payment Reference, not the normal Payment Reference.
You can tell the two apart, as the Subscription Payment Reference starts with tbx-r-
and not tbx-
.
You can find the Subscription Payment Reference in three places:
- On the payment confirmation screen after completing your purchase.
- In your subscription confirmation email from Tebex after purchase.
- In your Tebex Payment History, located here.
Treat your Subscription Payment Reference like a password.
Do not post it publicly.
Do not share it other people/server owners/developers.
Text-to-Speech usage is monitored, and abuse will result in consequences.
Text-to-Speech Language
ic_sa_ttsLanguage
This value determines which language the TTS should use.
The default value is en-us
for American English.
The following languages are available:
Language | Value |
---|---|
Arabic (Egypt) | ar-eg |
Arabic (Saudi Arabia) | ar-sa |
Bulgarian | bg-bg |
Catalan | ca-es |
Chinese (China) | zh-cn |
Chinese (Hong Kong) | zh-hk |
Chinese (Taiwan) | zh-tw |
Croatian | hr-hr |
Czech | cs-cz |
Danish | da-dk |
Dutch (Belgium) | nl-be |
Dutch (Netherlands) | nl-nl |
English (Australia) | en-au |
English (Canada) | en-ca |
English (Great Britain) | en-gb |
English (India) | en-in |
English (Ireland) | en-ie |
English (United States) | en-us |
Finnish | fi-fi |
French (Canada) | fr-ca |
French (France) | fr-fr |
French (Switzerland) | fr-ch |
German (Austria) | de-at |
German (Germany) | de-de |
German (Switzerland) | de-ch |
Greek | el-gr |
Hebrew | he-il |
Hindi | hi-in |
Hungarian | hu-hu |
Indonesian | id-id |
Italian | it-it |
Japanese | ja-jp |
Korean | ko-kr |
Malay | ms-my |
Norwegian | nb-no |
Polish | pl-pl |
Portuguese (Brazil) | pt-br |
Portuguese (Portugal) | pt-pt |
Romanian | ro-ro |
Russian | ru-ru |
Slovak | sk-sk |
Slovenian | sl-si |
Spanish (Mexico) | es-mx |
Spanish (Spain) | es-es |
Swedish | sv-se |
Tamil | ta-in |
Thai | th-th |
Turkish | tr-tr |
Vietnamese | vi-vn |
Text-to-Speech Voice
ic_sa_ttsVoice
This value determines which voice the TTS should use.
The default value is Mary
which works with en-us
.
Not all voices work with all languages.
The following voices are available:
Language name | Voice | Voice gender |
---|---|---|
Arabic (Egypt) | Oda | Female |
Arabic (Saudi Arabia) | Salim | Male |
Bulgarian | Dimo | Male |
Catalan | Rut | Female |
Chinese (China) | Luli | Female |
Shu | Female | |
Chow | Female | |
Wang | Male | |
Chinese (Hong Kong) | Jia | Female |
Xia | Female | |
Chen | Male | |
Chinese (Taiwan) | Akemi | Female |
Lin | Female | |
Lee | Male | |
Croatian | Nikola | Male |
Czech | Josef | Male |
Danish | Freja | Female |
Dutch (Belgium) | Daan | Male |
Dutch (Netherlands) | Lotte | Female |
Bram | Male | |
English (Australia) | Zoe | Female |
Isla | Female | |
Evie | Female | |
Jack | Male | |
English (Canada) | Rose | Female |
Clara | Female | |
Emma | Female | |
Mason | Male | |
English (Great Britain) | Alice | Female |
Nancy | Female | |
Lily | Female | |
Harry | Male | |
English (India) | Eka | Female |
Jai | Female | |
Ajit | Male | |
English (Ireland) | Oran | Male |
English (United States) | Linda | Female |
Amy | Female | |
Mary | Female | |
John | Male | |
Mike | Male | |
Finnish | Aada | Female |
French (Canada) | Emile | Female |
Olivia | Female | |
Logan | Female | |
Felix | Male | |
French (France) | Bette | Female |
Iva | Female | |
Zola | Female | |
Axel | Male | |
French (Switzerland) | Theo | Male |
German (Austria) | Lukas | Male |
German (Germany) | Hanna | Female |
Lina | Female | |
Jonas | Male | |
German (Switzerland) | Tim | Male |
Greek | Neo | Male |
Hebrew | Rami | Male |
Hindi | Puja | Female |
Kabir | Male | |
Hungarian | Mate | Male |
Indonesian | Intan | Male |
Italian | Bria | Female |
Mia | Female | |
Pietro | Male | |
Japanese | Hina | Female |
Airi | Female | |
Fumi | Female | |
Akira | Male | |
Korean | Nari | Female |
Malay | Aqil | Male |
Norwegian | Marte | Female |
Erik | Male | |
Polish | Julia | Female |
Jan | Male | |
Portuguese (Brazil) | Marcia | Female |
Ligia | Female | |
Yara | Female | |
Dinis | Male | |
Portuguese (Portugal) | Leonor | Female |
Romanian | Doru | Male |
Russian | Olga | Female |
Marina | Female | |
Peter | Male | |
Slovak | Beda | Male |
Slovenian | Vid | Male |
Spanish (Mexico) | Juana | Female |
Silvia | Female | |
Teresa | Female | |
Jose | Male | |
Spanish (Spain) | Camila | Female |
Sofia | Female | |
Luna | Female | |
Diego | Male | |
Swedish | Molly | Female |
Hugo | Male | |
Tamil | Sai | Male |
Thai | Ukrit | Male |
Turkish | Omer | Male |
Vietnamese | Chi | Male |
Text-to-Speech Rate
is_sa_ttsSpeechRate
This value determines how fast the TTS will be read.
The default value is -1
, valid values are between -10
and 10
.
Suggested values are between -2
and 0
.
Follow-Up Messages
ic_sa_followUpAlertMessages
If this value is true
, "90 seconds" and "120 seconds" will be read automatically.
This is to inform firefighters on station how long it has been since an Alert was activated.
Repeat TTS Message Twice
ic_sa_repeatMessage
If this value is true
, the TTS message will be repeated twice when it is read.
Repeat Tone At End Of TTS
ic_sa_repeatMessage
If this value is true
, the selected Tone for an Alert will be played again at the end of the TTS.
Permissions
There are several permissions for SA, they are as follows:
Use Door Controls
InfernoStationAlert.DoorControls
This permission allows players to interact with the Door Controls to open/close Doors.
By default, this permission is granted to all players.
Use Station Computer
InfernoStationAlert.Computer
This permission allows players to interact with the Station Computer to create Alerts.
By default, this permission is granted to all players.