Installation

1. Move script folder to your server resources

2. Rename the folder to either 'evo_sound' or 'xsound'

3. Add ensure evo_sound or ensure xsound to your server.cfg file

4. (optional) if you want to use built-in interact_sound compatibility, move all your sounds to /ui_prod/sounds/

Setting script name to 'xsound' allows you to use all xsound exports['xsound'], ensuring 100% compatibility with your resources

Initial config

Script comes ready to be used but there are a few config values you should check:

1. Config.locale: should be set to your server language. If the locale file for your server language does not exist just go to /locales folder, duplicate en-US.json file, rename it to whatever your locale is (eg. fr-FR.json), translate the file itself (just translate the values, not the keys) and change Config.locale to whatever you renamed it before (without the .json extension)

2. Config.interactSoundFile: if you are using built-in interact_sound compatibility, check that this value corresponts to the extension of your audio files

3. Config.defaultVolumeMode: this value comes set to user by default, change it to game if you want user volume to sync with in-game music volume. It is set to user by default to avoid users with in-game music muted to not hear anything. Users will be able to choose their volume mode inside the volume menu

4. Config.commandMute & Config.commandMenu: change this to whatever you want for the mute aka 'streamermode' command and volume menu command

You should be ready to go after that, if you want to learn more about other config values, read Config