This guide will help you configure the script to suit your needs, covering all available options in the config.lua file. Each setting is explained step by step.
1. General Configuration
Language
Set the language used by the script.
Config.Language = 'en' -- Available options: 'en' (English), 'fr' (French)
Use Outdated Version
Enable this option to suppress alert messages when using an older version of the script.
Config.UseOutdatedVersion = false -- Set to true if using an outdated script version.
2. Framework Compatibility
If you're using a framework like ESX, QB, or OX Inventory, enable this setting.
Config.UseFramework = false
When true, the system uses the inventory (e.g., weapon usage) instead of command-based interactions.
Setup instructions for each framework are available on:
3. Voice System Compatibility
Note: Only one voice system can be enabled at a time.
PMA-Voice Compatibility
Enable this option if your server uses PMA-Voice.
Config.Compatibility.PMAVoice = {
enabled = false, -- Set to true if using PMA-Voice.
resourceName = 'pma-voice' -- Name of the PMA-Voice resource.
}
SaltyChat Compatibility
Enable this option if your server uses SaltyChat.
If you're not sure which version of SaltyChat you are using:
Try enabling the new version (UseNewVersion = true).
Launch the game and test the megaphone.
If you see an error in the F8 client console, switch to UseNewVersion = false and set UseOldVersion = true.
Config.Compatibility.SaltyChat = {
UseNewVersion = true, -- Use this for the latest SaltyChat (LUA or C# integration)
UseOldVersion = false -- Use this for older versions of SaltyChat support
}
YACA Compatibility
Enable this option if your server uses YACA.
Config.Compatibility.YACA = {
enabled = false, -- Enable if using YACA.
resourceName = 'yaca' -- Name of the YACA resource.
}
Mumble-VOIP Compatibility
Enable this option if your server uses Mumble-VOIP.
Config.Compatibility.MumbleVOIP = false -- Set to true if using Mumble-VOIP.
4. Megaphone Behavior Settings
Auto Push-to-Talk
Automatically activates push-to-talk while using the megaphone.
Config.AutoTalk = true -- Set to true to auto-enable push-to-talk when using the megaphone.
Talk Distance
Defines the speaking range of the megaphone.
Config.TalkDistance = 35.0 -- Adjust the distance players can hear the megaphone.
For PMA-Voice users, modify this in @pma-voice/client/megaphone.lua.
Manage Volume
Allows players to adjust megaphone volume.
Config.ManageVolume = true -- Set to true to enable volume control.
Config.Volume = 1.0 -- Default volume level.
Voice Effects
Applies frequency filters to simulate a real megaphone sound.