Skip to main content

Music & Equalizer

Music distance, max volume, default playlist, and the 5-band parametric equalizer presets.

This section

Music & Equalizer

All music-related options in shared/config.lua. The YouTube API key lives in server/config.lua (Server Config).

Distance & Volume

lua
Config.Distance = 30.0 -- meters — how far other players can hear
Config.MaxVolume = 100 -- 1-100 server-wide cap
  • Distance controls 3D positional audio falloff. Volume scales linearly with distance: full at 0 m, silent at Distance m
  • MaxVolume caps the actual output even at slider 100%. Use this to enforce a server-wide volume policy

Default Playlist (Server-Wide)

Songs added here appear under the Home tab for every player:

lua
Config.MainMusics = {
{url = "https://www.youtube.com/watch?v=dQw4w9WgXcQ", title = "Rick Astley - Never Gonna Give You Up"},
{url = "https://www.youtube.com/watch?v=...", title = "Another Song"},
}

Each entry needs url (YouTube watch URL) and title (display name).

  • Players cannot remove these from their library
  • Players can add them to personal playlists
  • Useful for radio stations, server theme songs, RP-event playlists

Empty array ({}) means no default songs.

Equalizer Presets

lua
Config.EQPresets = {
flat = { label = "Flat", subBass = 0, bass = 0, mid = 0, treble = 0, brilliance = 0 },
bass_boost = { label = "Bass Boost", subBass = 6, bass = 4, mid = 0, treble = -1, brilliance = 0 },
rock = { label = "Rock", subBass = 4, bass = 3, mid = -1, treble = 3, brilliance = 4 },
pop = { label = "Pop", subBass = -1, bass = 2, mid = 4, treble = 3, brilliance = 0 },
vocal = { label = "Vocal", subBass = -3, bass = -1, mid = 5, treble = 3, brilliance = 1 },
classical = { label = "Classical", subBass = 0, bass = 0, mid = -2, treble = 3, brilliance = 5 },
}

EQ Bands

BandCenter frequencyDescription
subBass60 HzSub-bass — the rumble; affects bass-heavy music
bass250 HzBass — body of the kick drum & bass guitar
mid1 kHzMidrange — vocals, snare, guitars
treble4 kHzTreble — cymbals, sibilance, presence
brilliance12 kHzBrilliance — air, sparkle

Each band accepts gain in dB, range −12 to +12. Higher = louder.

Preset Structure

FieldTypeDescription
labelstringDisplay name shown in the UI
subBassnumberSub-bass gain in dB (−12 to +12)
bassnumberBass gain in dB
midnumberMid gain in dB
treblenumberTreble gain in dB
brilliancenumberBrilliance gain in dB

Adding a Custom Preset

lua
Config.EQPresets.electronic = {
label = "Electronic",
subBass = 8,
bass = 5,
mid = -2,
treble = 5,
brilliance = 7,
}

The key (electronic) is the internal name. The label is what users see.

Removing a Preset

Just delete the entry. The UI updates automatically.

Resetting to Flat

Players can always pick the flat preset (all 0s) to disable EQ effects.

Module Toggle

OptionDefaultDescription
Config.Modules.MusicPlayertrueShow the music player module