Configuration
Warning: Don't touch these lines
Config = {}
Config.Zones = {}
CONFIGURATION FILE
Config = {}
Config.Zones = {}
-- $$$$$$\ $$$$$$\ $$\ $$\ $$$$$$$$\ $$$$$$\ $$$$$$\ $$\ $$\ $$$$$$$\ $$$$$$\ $$$$$$$$\ $$$$$$\ $$$$$$\ $$\ $$\
--$$ __$$\ $$ __$$\ $$$\ $$ |$$ _____|\_$$ _|$$ __$$\ $$ | $$ |$$ __$$\ $$ __$$\\__$$ __|\_$$ _|$$ __$$\ $$$\ $$ |
--$$ / \__|$$ / $$ |$$$$\ $$ |$$ | $$ | $$ / \__|$$ | $$ |$$ | $$ |$$ / $$ | $$ | $$ | $$ / $$ |$$$$\ $$ |
--$$ | $$ | $$ |$$ $$\$$ |$$$$$\ $$ | $$ |$$$$\ $$ | $$ |$$$$$$$ |$$$$$$$$ | $$ | $$ | $$ | $$ |$$ $$\$$ |
--$$ | $$ | $$ |$$ \$$$$ |$$ __| $$ | $$ |\_$$ |$$ | $$ |$$ __$$< $$ __$$ | $$ | $$ | $$ | $$ |$$ \$$$$ |
--$$ | $$\ $$ | $$ |$$ |\$$$ |$$ | $$ | $$ | $$ |$$ | $$ |$$ | $$ |$$ | $$ | $$ | $$ | $$ | $$ |$$ |\$$$ |
--\$$$$$$ | $$$$$$ |$$ | \$$ |$$ | $$$$$$\ \$$$$$$ |\$$$$$$ |$$ | $$ |$$ | $$ | $$ | $$$$$$\ $$$$$$ |$$ | \$$ |
--\______/ \______/ \__| \__|\__| \______| \______/ \______/ \__| \__|\__| \__| \__| \______| \______/ \__| \__|
--Use "esx" or "qb"
Config.Framework = "esx"
--Default ESX: "esx:getSharedObject" | Default QB: "qb-core"
Config.Core = "esx:getSharedObject"
--Command to open the radio menu
Config.Command = "music"
--Maximum distance from which the sound will be heard
Config.VolumeDistance = 50.0
--If you want everyone to listen to the music or only the one who plays the music
Config.EveryoneHears = true
--Key with which the menu is to be opened
Config.OpenKey = 170 -- F3 https://docs.fivem.net/docs/game-references/controls/
Configuration Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| Config.Framework | string | "esx" | Framework to use: "esx" or "qb" |
| Config.Core | string | "esx:getSharedObject" | Core event name (ESX: "esx:getSharedObject", QB: "qb-core") |
| Config.Command | string | "music" | Command to open the radio menu |
| Config.VolumeDistance | float | 50.0 | Maximum distance from which the sound will be heard (in game units) |
| Config.EveryoneHears | boolean | true | If true, everyone within range hears the music. If false, only the player hears it |
| Config.OpenKey | integer | 170 | Key code to open the radio menu (170 = F3). See FiveM controls reference |
Framework Setup
For ESX:
Config.Framework = "esx"
Config.Core = "esx:getSharedObject"
For QBCore:
Config.Framework = "qb"
Config.Core = "qb-core"
Command Configuration
Players can use the configured command to open the radio menu:
Config.Command = "music" -- Players use /music in chat
Audio Settings
Volume Distance controls how far away other players can hear the music:
Config.VolumeDistance = 50.0 -- 50 game units range
Everyone Hears determines if the music is shared:
Config.EveryoneHears = true -- Everyone within range hears the music
Config.EveryoneHears = false -- Only the player who started it hears it
Key Binding
Customize which key opens the radio menu:
Config.OpenKey = 170 -- F3 key
Tip: Find key codes in the FiveM controls documentation.
Common key codes:
- F3 = 170
- E = 38
- Enter = 191
- Backspace = 177