Configuration

Open /djadmin to manage clubs and global settings. Complete Installation first, then choose how the global configuration should be managed.

Choose SQL or file settings

Config.IngameSettings = true is the default. This switch is read from config/config.lua and requires a resource restart after editing.

Switching to file mode does not copy saved SQL values into Lua. Review the file settings before switching. It disables global settings saves in-game and leaves the saved SQL settings intact for switching back later. Clubs, speaker and effect layouts, playlists and the boombox journal remain in SQL in either mode.

Sky DJ creates its sky_dj_state table and missing records automatically through sky_base. Back up this table before updating or changing the configuration mode. Sky DJ has its own administration interface; it does not require sky_jobs_base or register a /jobconfig section.

Find a setting

Paths below are relative to the installed sky_dj resource. The reference lists shipped defaults; an existing installation can have different saved values. Numeric ranges are the server's accepted global-settings ranges. Keep file-mode values inside those ranges too.

IngameSettings is a Boolean with default true; it is the file-owned mode switch described above. The remaining Config keys are listed in the sections below. Where the current editor has no control for a compatibility setting, this is stated explicitly.

Audio and DJ limits

Open Settings → Audio & DJ in SQL mode.

Lua volume values are multipliers: 1.0 means 100%, and 2.0 means 200%. The administration interface displays percentages. The ceiling does not raise each club's saved volume or replace individual speaker tuning. Lower existing club and speaker values before reducing a global limit below them; the server rejects incompatible limits.

Start with the smallest speaker ranges that cover your venue, then tune speaker direction and gain in the club. Increasing marker distance only makes the interaction easier to find. The Mixer and audio guide covers the separate per-club mix and speaker controls.

Administrator and DJ access

The default command is /djadmin. Set AdminCommand without a leading slash when renaming it. An old saved default /clubadmin is migrated to /djadmin; custom saved command names are retained.

The file-mode entries are:

AdminCommand = 'djadmin',
AdminGroups = { admin = true, superadmin = true },
AdminAce = 'sky.dj.admin',

Edit these entries inside the existing Config table only when using file mode. In SQL mode, change Settings → Permissions instead. Administration accepts the configured ESX groups or the configured ACE permission. Keep your own group or a valid ACE permission when saving; the server rejects a change that would remove your access.

Club access is separate. In the club editor, DJ access can allow administrators only, a job with a minimum rank, or All players. Allowing all players to use a DJ booth grants no global administration or playlist-management rights. DJ and FOH control also require the correct nearby interaction and routing bucket; access alone does not provide remote control.

Music folder and delivery

Open Settings → Music & Playlists → Library & Queues for these global values.

The default MusicDirectory = 'config/music' uses the music folder inside sky_dj. In SQL mode, change Music & Playlists → Library & Queues → Music folder. An alternative such as @sky_dj_music/music selects a folder in another started resource on the same server. Use forward slashes and a resource-relative folder, not an absolute operating-system path.

Resource names use letters, digits, _ and - and are at most 64 characters. Each folder segment starts with a letter, digit, _ or -; subsequent characters can also include spaces and periods. Traversal (..), duplicate slashes, control characters and absolute paths are rejected. The catalog scans the selected folder rather than recursive subfolders. Keeping a music folder in another resource still requires that resource to be started and configured for the chosen delivery mode.

With the default folder selection, HTTPS mode uses the private config/music-stream export produced by the preparation tool. Files can remain on the same server machine, but a working HTTPS host is still required. Node.js and FFmpeg are preparation tools for this optional delivery mode, not dependencies of normal resource MP3 playback.

Use a folder URL such as https://audio.example.com/music/, without credentials, query parameters or a fragment. A valid explicit port is supported. Saved URLs are normalized with a trailing slash; track URLs come from the server's prepared catalog. Selecting a folder or URL does not install a web server or convert the library for you. Follow Installation for music preparation and publishing.

Keep the same track filenames when moving a library so saved playlist references remain valid. See Mixer and audio for the club playback workflow. The mobile boombox has separate YouTube and Spotify pages.

Music Sync reference

Global Config.MusicSync settings are edited under Settings → Music synchronization. The tabs are Source, Channels, Response, Quiet and Detection. The paths below are written in full so they can also be found in config/config.lua.

The global enable switch controls normal clubs. The fixed festival has separate FOH → Music Sync enable, mode and channel controls. Its analysis also uses shared detection/response values, so global sensitivity changes can affect a festival show that has FOH synchronization enabled. Use the FOH controls for festival participation and overrides.

Source and sensitivity

Pulse timing and show response

The depth values are stored as 0–1 fractions and shown as 0–100% in the editor. They blend response with the active fixture/preset; they do not replace every fixture's own settings.

Quiet sections

Detection and frequency bands

minBpm must be strictly below maxBpm, and fallbackBpm must lie between them. Each band's lower frequency must be strictly below its upper frequency. These relationships are checked in addition to the individual ranges.

Channel switches

Every channel below defaults to true and accepts a Boolean. They select which existing effect families follow synchronization; they do not place props or enable a disabled device.

Tune with an assigned MP3 playing on the selected deck. Start with one visible channel and the defaults. If the show barely reacts, check deck playback, the global or FOH enable switch and device participation first. Then adjust the relevant sensitivity in small steps. For unwanted activity during quiet passages, tune noiseFloor and quietThreshold before raising every response depth. Change timing separately from detection so it is clear which value helped. See Lights and effects for manual shots and festival-specific behavior.

Boombox settings

Open Settings → Boombox. Boombox volume and radius have independent ceilings from the club system.

BoomboxDui and BoomboxDuiDistance remain in saved/global configuration for compatibility. They have no controls in the current editor, and the player panel has no display selector. Unrelated settings saves preserve them. Use the documented file mode when intentionally managing these file values. New devices start with display mode off.

Keep the fixed radius appropriate for a portable speaker. Raising BoomboxMaxAudible permits more overlapping online players on each client; it does not improve the sound of one device. See Boombox for placement-first behavior, item definitions, shared access and restart recovery.

Festival grounds and fences

FestivalGroundEnabled = true enables the fixed Vespucci Beach venue and its DJ booth. It can be changed under Settings → Festival grounds. This switch controls the supplied festival; it is separate from the custom clubs you create.

FestivalFencesEnabled = true controls the festival perimeter fences independently. Fences require the festival grounds to be enabled. Set it to false to keep the festival without its supplied fence perimeter.

MusicSync.enabled is false by default and controls normal club synchronization. The fixed festival has its own FOH → Music Sync controls, also enabled explicitly; save there to return manually overridden festival channels to automatic control. Manual controls remain available without music. Devices saved as disabled do not follow presets or Music Sync. The FOH panel shows their counts and offers separate actions to enable the flame or CO₂ devices. See Lights and effects for show operation.

Retained media timeout

This setting has no current global-editor field. The current club library resolves local catalog entries rather than online media requests, so changing it does not extend MP3 loading timeouts. Mobile YouTube metadata has its own fixed five-second lookup timeout. Keep the default; the current UI has no online resolution workflow that needs tuning here.

Advanced audio file

config/audio.lua defines SkyDjAudioConfig, separately from Config and SQL global settings. Edit the file and restart to apply it. These values have no configurator range validation; use the shipped values as the baseline.

Avoid enabling two resources that both handle the same InteractSound events. The normal DJ/boombox system uses the embedded engine without requiring this emulator or a separate sound resource.

Sample catalog and per-club soundboard

config/soundboard.lua defines the file-owned ClubSamples catalog. Every entry has a stable id, a label, a sample file and its duration in seconds. Preserve IDs and the 16-entry layout when replacing a sound so saved club pad assignments keep their meaning. The runtime indexes the catalog by its position, matching the shipped IDs 1–16.

The file is resolved under source/html/samples/. A replacement must exist there and be included in the resource manifest. Keep duration aligned with the actual recording because the server uses it for sample lifetime and cleanup. Changing this Lua catalog requires a restart; adding runtime audio files also requires publishing those assets correctly.

The mixer's Soundboard & mixer panel manages separate per-club settings saved in SQL:

Save with Save for this club. Pads use 1–8 and Q W E R T Z U I while the mixer is active; the loop switch repeats a pad, and sample cut cancels active samples. At most four samples can play simultaneously, and loops stop after 30 seconds. These playback limits are fixed behavior, not additional Config settings.

Language and dependencies

Sky DJ follows Sky.Config.locale from sky_base, with English fallback. Its 19 JSON dictionaries are in config/locales/. There is no separate Config.Locale setting in Sky DJ.

The resource requires ESX, OneSync, ox_lib and sky_base. SQL uses the provider configured by sky_base; do not add a second audio resource or assume another framework is supported because an integration uses a Sky facade. A configured target provider is optional; the standard interaction uses the Sky TextUI/help adapter when target is disabled. See Installation for startup order and Troubleshooting for access or configuration errors.