Roblox

Manual install

Prefer one click? Use the Studio plugin. This page is for copying files yourself or CI pipelines.

1. Download the SDK

The ZIP includes FluxConfig.lua, FluxShared.lua, FluxClient.lua, and FluxServer.lua. Init scripts are not in the ZIP; copy them from step 2 below (same source as the plugin generates).

Download FluxRobloxSDK.zip

SDK last updatedJune 25, 2026 . Reopen the Flux Roblox Studio plugin and click Update if you installed before this date.

2. Add files in Studio

Modules

  1. In ReplicatedStorage, create ModuleScripts FluxConfig, FluxShared, and FluxClient. Paste the matching files from the ZIP.
  2. In ServerScriptService, create FluxServer and paste FluxServer.lua.
  3. In ReplicatedStorage, add a RemoteEvent named FluxRemoteEvent if you do not have one yet.

FluxServerInit (server Script)

In ServerScriptService, create a Script named FluxServerInit:

--!strict
local FLUX_API_KEY = "flux_your_project_key"

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

FluxServer.Init(FLUX_API_KEY)

FluxClientInit (LocalScript)

Under StarterPlayer → StarterPlayerScripts, create a LocalScript named FluxClientInit:

--!strict
local ReplicatedStorage = game:GetService("ReplicatedStorage")
require(ReplicatedStorage:WaitForChild("FluxClient"))

Keep FluxServer on the server only. Do not put it under ReplicatedStorage.

3. Add your API key

  1. In the Flux dashboard: Projects → your project → Settings → copy the API key (flux_…).

Open ServerScriptService → FluxServerInit and add the key there only — never in client scripts.

Studio playtests

Replace the placeholder with your project key:

local FLUX_API_KEY = "flux_your_project_key"

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

FluxServer.Init(FLUX_API_KEY)

Published games

Do not ship the raw flux_… string in source. Store it in Roblox's secrets store and pass the secret name to FluxServer.Init.

  1. Creator Dashboard → your experience → Configuration Secret.
  2. Create a secret: Name flux_api_key, Secret your flux_… key, Domain fluxrbx.com.
  3. In FluxServerInit, use the name — not the key value:
FluxServer.Init("flux_api_key")

Testing in Studio? Add the same secret under File → Experience Settings → Security → Secrets.

API keys — rotation and security tips.

4. Next steps

Enable HTTP and send a test log. Continue from step 3 in Quick start. Client scripts can require FluxClient; they do not need your API key.