Setting Up DataStore Sync

How to enable Owner Mode to automatically synchronize approved audio assets to your live game.

The Owner Mode (DataStore Sync) feature allows you to seamlessly push approved audio assets directly into your live Roblox experience's DataStore.

1. Prerequisites

Before enabling this feature, you must have the following ready:

A running Bridge Server: A separate web service capable of receiving the sync payload. (See the Bridge API Reference for details on setting this up).
A Bridge Secret: A custom, secure password you define yourself to authenticate requests.
Roblox Lua Setup: The LiveMusicIngestion.luau module must be present in your Roblox experience.

Secret Match Required: The Bridge Secret you define must match exactly on both the desktop application side and your bridge server's environment configuration.

2. Enabling Owner Mode in the App

To turn on DataStore synchronization:

Open the Configuration panel in the app.
Toggle Owner Mode to Enabled.
Select the appropriate Category for your upload:
- Standard Library: For general, persistent audio assets.
- Event Mix: For special, time-limited event audio.
Enter your Bridge Server URL and your custom Bridge Secret.

3. The Synchronization Process

Once Owner Mode is enabled, the workflow changes slightly.

After a batch is fully uploaded and approved by Roblox moderation, the app automatically compiles a structured JSON payload containing the metadata for every approved track (including audio ID, duration, genre, speed mode, and title).

The app then makes a POST request to your Bridge Server URL, using your Bridge Secret in the x-bridge-secret header for authentication. The Bridge Server then routes this data to your live game's DataStore.

4. Handling Sync Failures

If the network connection drops or your Bridge Secret was entered incorrectly, the sync step might fail even though the files successfully uploaded to Roblox.

If this happens:

Verify and fix your Bridge Server URL or Bridge Secret in the Configuration panel.
Click the Retry Bridge Sync button that appears.

No Duplicate Uploads: Clicking "Retry Bridge Sync" only resends the JSON metadata payload to your bridge server. It does not attempt to re-upload the original audio files to Roblox, preventing duplicates and saving you time.

5. Roblox Lua Integration Notes

For the sync to function inside your Roblox game, the LiveMusicIngestion.luau module handles the incoming data.

Important integration detail: Because of how Knit framework injection works, LiveMusicIngestion.luau must be explicitly initialized from within MusicService:KnitStart(). It is not automatically loaded by Knit unless it resides in a recognized service Components folder, so ensure you manually require and initialize it at startup.