Config

There are many settings that can be modified in the config.lua file located at the root folder of the script.

General

Variable
Default
Type
Description

locale

'en-US'

string

Script locale, make sure it exists inside /locales folder

debug

false

boolean

Set to false on prod

verbosity

0

number

Log verbosity level

useEventSecurity

true

boolean

Use event security?

interactSoundFile

"ogg"

string

interactSound files format (ones located at /ui_prod/sounds)

checkTime

500

number

How often script checks for close music

positionCheckDistance

35

number

Distance from sound to start position calc

interactSoundEnable

true

boolean

Enable interact_sound events?

defaultVolumeMode

'user'

string

'game' will take ingame music volume as base volume, 'user' will take /volume menu input

updateInterval

200

number

Main thread interval

commandMute

streamermode

string

Command to mute music

commandMenu

volume

string

Command to open volume menu

3D Audio

Variable
Default
Type
Description

tridimensional.algorithm

'linear'

string

Distance/volume algorithm

tridimensional.noLossPercentage

0.1

number

No volume loss zone. eg. 20m sound, 0.1 means first 10% of the sound range (2m) will have no reduction

Spatial Audio

Variable
Default
Type
Description

spatial.enabled

true

boolean

Enable spatial sound?

spatial.stereoMul

0.75

boolean

Defines stereo pan multiplier

Audio Filters

Variable
Default
Type
Description

filter.enabled

true

boolean

Enable filtering on PlayUrlPos?

filter.filterWater

true

boolean

Filter when listener is in water and sound out

filter.filterInterior

true

boolean

Filter when listener and source are not in the same interior

filter.baseFreq

22000

number

Base freq

filter.waterFreq

200

number

Filter freq when filtering water

filter.interiorFreq

200

number

Filter freq when filtering interior

filter.transitionTime

0

number

Filter transition time

filter.transitionMode

'exponential'

string

Filter transition algorithm

filter.volReduction

0.75

number

Multiply volume by this value when filtered

Last updated