Flux

Quick start

Wire Flux in Studio

Do these steps in order. If HTTP fails, open HTTP in Studio.

1. Download the SDK

Unzip the archive, then paste each file into the matching Studio instance (step 2).

Download Full SDKTestFlux.server.luaFull install reference

Endpoint /api/sdk/flux-sdk serves FluxRobloxSDK.zip. Outline button: smoke-test script (not in the ZIP).

2. Place files in Explorer

For each row: open the service in Explorer, insert the object type, rename to match, paste the whole file from the ZIP into the script editor (replace the default line).

Names must match exactly — for example FluxServer and FluxClient, because require(…:WaitForChild("FluxServer")) looks for that spelling.

File on disk (from ZIP)Explorer serviceInsert →Rename instance to
FluxShared.luaReplicatedStorageModuleScriptFluxShared
FluxClient.luaReplicatedStorageModuleScriptFluxClient
FluxServer.luaServerScriptServiceModuleScriptFluxServer
  • The first FluxServer.Init creates FluxRemoteEvent in ReplicatedStorage if it is missing (so client code can wait on the same name).
  • Do not place FluxServer under ReplicatedStorage — it must stay server-only.

Optional: TestFlux (separate download)

File on diskExplorer serviceInsert →Rename instance to
TestFlux.server.luaServerScriptServiceScriptTestFlux

After pasting, set TEST_API_KEY at the top of TestFlux to your real key, then press Play.

3. Get a project API key

Someone on your team with access to Flux signs in, creates a project for your game (or environment), and copies the key from Projects → your project → Settings. Keys look like flux_…. Use this key only in FluxServer.Init on the server — never in FluxClient or LocalScripts. See API keys.

4. Allow HTTP in Studio

In Roblox Studio: File → Experience Settings (or Game Settings on older Studio) → Security → turn on Allow HTTP Requests. Only the server needs HTTP for Flux (client logs go through RemoteEvent). If your team uses an HTTP allowlist, add the hostname of your Flux deployment. Full walkthrough: HTTP in Studio.

5. Send a test log

Fastest: if you added TestFlux in step 2, set TEST_API_KEY and press Play.

Manual (server): add a new Script under ServerScriptService (any name), paste:

local ServerScriptService = game:GetService("ServerScriptService")
local FluxServer = require((ServerScriptService:WaitForChild("FluxServer")) :: ModuleScript)

FluxServer.Ping()

FluxServer.Init("flux_paste_your_key_here")

FluxServer.Info("Flux quick start OK", "System", {
  placeId = tostring(game.PlaceId),
})

Logs should show in the dashboard within a few seconds (batched + retried automatically). Reference: API docs.