Browse docs

Changelog

Release notes and installation steps for sky_dj.
The current Sky DJ package is Experimental / not stable. Both music modes use original MP3s in one config/music/ folder. Follow the current Installation guide for the Normal optional music pack and optional Experimental selected-song delivery; no external music host or conversion tool is required.
Prepared

Version 0.0.1

Highlights

  • Added the first numbered Sky DJ package with two-deck MP3 mixing, playlists, automix and spatial club speakers.
  • Added club administration, placeable stage equipment and lighting controls with saved settings and layouts.

Notable Changes

  • Added portable boomboxes with shared YouTube playback and a separate personal Spotify player.
  • Added the included festival map and FOH controls, with owner-local speaker and tent models excluded from the public package.

Other Changes

  • Added optional Sky profiler labels for manually recorded FiveM diagnostics, disabled by default.
  • Added 19 editable language catalogs and an embedded audio engine in the same resource.

Changed Files

  • sky_dj/config/config.lua
  • sky_dj/config/audio.lua
  • sky_dj/config/soundboard.lua
  • sky_dj/config/locales/*
  • sky_dj/fxmanifest.lua
  • sky_dj/stream/*
  • sky_dj/source/* — delete and reinsert
Update InstructionsWhat to copy, what to keep and what to checkinitial package0.0.1

Simplified update

Update sky_dj safely

Read the complete update instructions in one continuous guide.

  1. Prepare

This is the first prepared numbered package baseline, not an upgrade from a previously published numeric release. Back up any development installation, custom config/translations, music and the sky_dj_state database table. Preserve settings, clubs, devices, playlists and boombox claims. Stop the server for replacement. Use ESX with RunStaticPlayerMethod, OneSync, ox_lib, Sky Base and its configured SQL provider. No Jobs Base or separate sound resource is required. See Installation.

  1. Install the matching files

Install the central ZIP's complete sky_dj/ at resources/[sky]/sky_dj, with the manifest directly inside it. A standalone drag-and-drop wrapper stores the resource under resources/[sky]/sky_dj. Use all files from the same 0.0.1 package. For a development copy, delete and reinsert source/ completely, replace the matching manifest and public stream/, and refresh all 19 JSON locales while merging custom wording. Merge backed-up values into config/config.lua, config/audio.lua and config/soundboard.lua. Keep NUI, Lua and profiler manifest/helper together.

The public package excludes customer music, saved data and owner-local stream/tent / stream/speakers models. The public festival does not include those private models or a nightclub MLO. Preserve music separately and avoid mixing unrelated assets. Standalone wrapper documentation stays outside the runtime.

  1. Keep settings and SQL

Config.IngameSettings = true loads saved Sky DJ SQL settings; generated defaults seed only missing records. Use /djadmin with an allowed ESX group or sky.dj.admin ACE permission. With false, edit the existing config/config.lua; the saved SQL settings remain available. Clubs, devices and playlists always remain in SQL. Sky DJ has no /jobconfig section. Sky Base creates the table and missing rows automatically; no manual SQL import or reset is required. Follow Configuration, without replacing saved settings with defaults.

  1. Supply music and optional items

Put your original MP3s in config/music/ for both modes. Normal loads the complete optional music pack on first local MP3 use; Experimental requests only currently needed songs and waits for each complete MP3 before playback. Choose Experimental on-demand MP3 under Settings → Music & Playlists, confirm when enabling it, then save. Customers install no separate Node.js, Yarn, FFmpeg or music host. Keep the supplied manifest to avoid automatic connection downloads, and follow Installation for cache, active-club and custom-folder exceptions. Default /boombox placement requires no item. Before enabling item mode, register the configured sky_boombox entry using the Boombox guide and preserve outstanding item claims. Shared YouTube and personal Spotify playback are separate workflows.

  1. Start and verify

Start the SQL provider and ESX, then ox_lib, sky_base, any separate music resource and sky_dj. Restart the server and fully reconnect clients after installing map assets. Check startup errors, authorized /djadmin access, MP3 mixing, playlists, saved configuration, club/boombox controls and the public assets actually delivered. Confirm old SQL records remain. Do not start the previous club system alongside Sky DJ.

Optional diagnostics are disabled by default. Put setr sky_profiler 1 before Sky ensures, restart and record manually with the FiveM profiler. No recording or upload starts automatically. Disable with setr sky_profiler 0 and another restart. Keep the generated helper and matching manifest. Package checks do not establish gameplay, performance or encrypted Escrow acceptance.