> For the complete documentation index, see [llms.txt](https://docs.rainmad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rainmad.com/resources/dj-booth-television-and-carplay/configuration.md).

# Configuration

## General Configuration

```lua
Config.general = {
    commands = {
        quiet = 'quietmode', -- mutes everything for the player
        admin = 'watchparty', -- list | remove <id> | remove all | mute <id> | muteall
        boothEditor = 'boothedit', -- lays out a fixed booth for Config.djBooth.fixedBooths
    },

    colors = {
        accent = '#e0483d', -- highlights
        success = '#4ade80', -- success states
        text = '#ffffff', -- text
        muted = '#8d92a0', -- secondary text
        background = '#16171d', -- background
        panel = '#1e2027', -- panels
        panelLight = '#272a33', -- rows and cards
        line = '#33363f', -- borders
    },

    limits = {
        screensOnServer = 8,
        screensPerPlayer = 1,
        boothsOnServer = 4,
        boothsPerPlayer = 1,
    },

    permissions = {
        maxControllers = 5, -- players an owner can hand control to
        controlJobs = {}, -- jobs that control any booth, e.g. { 'police' }

        placeIdentifiers = {
            booth = {}, -- ['license:xxx'] = true

            screen = {}, -- ['license:xxx'] = true
        },
    },

    admins = {}, -- ['license:xxx'] = true

    media = {
        queueLength = 20, -- entries one booth holds
        perPlayer = 5, -- entries one player may queue
        addCooldown = 3000, -- ms between two additions
    },

    audio = {
        muffleBehindWalls = true, -- muffle speakers behind walls
    },

    placement = {
        maxDistance = 25.0, -- metres from the player
        partRadius = 30.0, -- metres from the booth or screen
    },

    blockedAreas = {}, -- { x = 0.0, y = 0.0, z = 0.0, w = 25.0 }
}
```

### Television Configuration

```lua
Config.television = {
    quality = 'medium', -- news broadcast: 'low' 270p, 'medium' 480p, 'high' 720p

    broadcast = {
        cameraItem = 'broadcast_cam',
        micItem = 'broadcast_mic',
        menuKey = 'F1', -- default key, players can rebind it
    },

    ratings = {
        enabled = true, -- channels earn from their viewers
        perViewerMinute = 8, -- per viewer, per minute
        maxPerMinute = 400,
        minViewers = 1,
    },

    channels = {
        {
            label = 'Weazel News',
            job = 'reporter',
            desk = vector3(-1055.809, -242.375, 44.021),

            blipOptions = {
                enable = true, -- false hides the map blip
                sprite = 184,
                color = 17,
                scale = 0.8,
                shortRange = true, -- minimap only when nearby
                label = 'Weazel News', -- defaults to the channel label
            },

            roles = {
                { name = 'Reporter', reqGradeLevel = 0 },
                { name = 'Producer', reqGradeLevel = 0 },
                { name = 'Chief', reqGradeLevel = 0 },
            },
        },
    },

    televisions = {
        { itemName = 'tv', model = 'prop_tv_flat_01' },
        { itemName = 'tv_wall', model = 'prop_tv_flat_02' },
        { itemName = 'tv_big', model = 'prop_tv_flat_03' },
        { itemName = 'tv_frameless', model = 'prop_tv_flat_01_screen' },
        { itemName = 'tv_panel', model = 'prop_tv_flat_02b' },
        { itemName = 'tv_desk', model = 'prop_tv_flat_03b' },
        { itemName = 'tv_lounge', model = 'prop_tv_flat_michael' },
        { itemName = 'tv_boxset', model = 'prop_tv_01' },
        { itemName = 'tv_portable', model = 'prop_tv_02' },
        { itemName = 'tv_dial', model = 'prop_tv_03' },
        { itemName = 'tv_cabinet', model = 'prop_tv_06' },
        { itemName = 'tv_trailer', model = 'prop_trev_tv_01' },
        { itemName = 'tv_monitor', model = 'prop_monitor_w_large' },
        { itemName = 'tv_laptop', model = 'prop_laptop_lester2' },
        { itemName = 'tv_junk', model = 'des_tvsmash_start' },
        { itemName = 'tv_theatre', model = 'vw_prop_vw_cinema_tv_01' },
        { itemName = 'tv_cinema', model = 'v_ilev_cin_screen' },
        { itemName = 'tv_overlay_flat', model = 'prop_flatscreen_overlay' },
        { itemName = 'tv_overlay_crt', model = 'prop_tv_03_overlay' },
    },

    fixedScreens = {}, -- { device = 'tv_big', coords = vector3(0.0, 0.0, 0.0), heading = 0.0 }
}

```

### DJ Booth Configuration

```lua
Config.djBooth = {
    consoleScale = 1.0, -- 0.9 for small screens
    micKey = 47, -- hold to talk, 47 is G
    cameraShake = true, -- shake on the bass

    talkover = {
        enabled = true, -- music ducks under the mic
        holdDistance = 10.0, -- metres before the mic is put down
    },

    lights = {
        range = 90.0, -- draw distance
        maxFixtures = 14, -- per booth
        placeDistance = 12.0, -- metres from the booth
    },

    nowPlaying = false, -- title above the booth

    smoke = {
        enabled = true,
        range = 60.0, -- draw distance
    },

    effects = { -- offsets used without effect machines
        firework = {
            label = 'Firework',
            asset = 'scr_indep_fireworks',
            effect = 'scr_indep_firework_starburst',
            scale = 2.2,
            offsets = { vector3(-3.2, 0.6, 3.4), vector3(3.2, 0.6, 3.4) },
        },
        confetti = {
            label = 'Confetti',
            asset = 'scr_xs_celebration',
            effect = 'scr_xs_confetti_burst',
            scale = 1.8,
            offsets = { vector3(0.0, 0.4, 5.2) },
        },
        co2 = {
            label = 'CO2',
            asset = 'core',
            effect = 'ent_sht_steam',
            scale = 3.0,
            rotation = vector3(-70.0, 0.0, 0.0),
            offsets = { vector3(-1.9, 0.7, 1.5), vector3(1.9, 0.7, 1.5) },
        },
        sparkler = {
            label = 'Sparklers',
            asset = 'scr_indep_fireworks',
            effect = 'scr_indep_firework_fountain',
            scale = 1.4,
            offsets = { vector3(-2.2, 0.5, 1.0), vector3(0.0, 0.5, 1.0), vector3(2.2, 0.5, 1.0) },
        },
        money = {
            label = 'Money',
            asset = 'scr_xs_celebration',
            effect = 'scr_xs_money_rain',
            scale = 2.6,
            offsets = { vector3(-2.8, 0.4, 5.4), vector3(2.8, 0.4, 5.4) },
        },
        flames = {
            label = 'Flames',
            asset = 'core',
            effect = 'ent_sht_flame',
            scale = 1.1,
            offsets = { vector3(-2.0, 0.3, 0.1), vector3(2.0, 0.3, 0.1) },
        },
    },

    soundboard = { -- files in sounds/, volume defaults to 0.9
        { id = 'riser', label = 'Riser', file = 'sounds/riser.mp3', volume = 0.7 },
        { id = 'impact', label = 'Impact', file = 'sounds/impact.mp3' },
        { id = 'subdrop', label = 'Sub Drop', file = 'sounds/subdrop.mp3' },
        { id = 'tapestop', label = 'Tape Stop', file = 'sounds/tapestop.mp3' },
        { id = 'scratch', label = 'Scratch', file = 'sounds/scratch.mp3' },

        { id = 'airhorn', label = 'Airhorn', file = 'sounds/airhorn.mp3' },
        { id = 'siren', label = 'Siren', file = 'sounds/siren.mp3' },
        { id = 'shot', label = 'Shot', file = 'sounds/shot.mp3' },
        { id = 'whistle', label = 'Whistle', file = 'sounds/whistle.mp3' },
        { id = 'boom', label = '808 Boom', file = 'sounds/boom.mp3' },

        { id = 'pullup', label = 'Pull Up', file = 'sounds/pullup.mp3' },
        { id = 'makenoise', label = 'Make Noise', file = 'sounds/makenoise.mp3' },

        { id = 'crowd', label = 'Crowd', file = 'sounds/crowd.mp3', volume = 0.8 },
        { id = 'applause', label = 'Applause', file = 'sounds/applause.mp3', volume = 0.8 },
    },

    requests = {
        enabled = true,
        max = 24,
        perPlayer = 3,
        cooldown = 20000, -- ms
    },

    fixedBooths = {}, -- paste the blocks the command gives here

    booth = {
        itemName = 'dj_booth',
        model = 'h4_prop_battle_dj_stand',
        defaultRange = 70.0, -- metres

        parts = {
            { id = 'speakers', count = 4, model = 'sf_prop_sf_speaker_stand_01a', facing = 180.0 },
            {
                id = 'lights',
                count = 2,
                model = 'v_club_rack',
                facing = 180.0,
                mounts = {
                    { kind = 'spot', offset = vector3(-0.76, 0.02, 1.07), rotation = vector3(0.0, 0.0, -180.0) },
                    { kind = 'spot', offset = vector3(0.01, 0.02, 1.07), rotation = vector3(0.0, 0.0, -180.0) },
                    { kind = 'spot', offset = vector3(0.81, 0.01, 1.06), rotation = vector3(0.0, 0.0, -180.0) },
                    { kind = 'laser', model = 'h4_prop_battle_lights_fx_lamp', offset = vector3(-1.01, -0.08, 1.05), rotation = vector3(-90.6, 0.0, -55.0) },
                    { kind = 'laser', model = 'h4_prop_battle_lights_fx_lamp', offset = vector3(1.06, -0.07, 1.05), rotation = vector3(-80.6, 0.0, -65.0) },
                },
            },
            { id = 'smoke', count = 2, model = 'h4_prop_club_smoke_machine', facing = 0.0 },
            { id = 'effects', count = 2, model = 'h4_prop_club_smoke_machine', facing = 180.0 },
            { id = 'mic', count = 1, model = 'v_club_roc_micstd' },
        },
    },
}

```

### CarPlay Configuration

```lua
Config.carPlayer = {
    key = 'F2', -- default key, players can rebind it
    range = 45.0, -- metres
    maxQueue = 20,

    blacklist = { -- vehicles without a stereo
        `bmx`,
        `cruiser`,
        `fixter`,
        `scorcher`,
        `tribike`,
        `tribike2`,
        `tribike3`,
    },
}

```
