Roblox

Install the Flux Roblox SDK

The SDK is split into a public client module (no API key), a server module (HTTP + key), and a shared types/helper module. See Security and API docs.

1. Download the SDK

Download one ZIP, unzip it, then create a ModuleScript per .lua file using the same base name (without extension) as in the archive.

Download Full SDK

Archive: FluxRobloxSDK.zip via GET /api/sdk/flux-sdk.

2. Explorer layout

ReplicatedStorage: FluxShared (ModuleScript), FluxClient (ModuleScript). FluxRemoteEvent (RemoteEvent) is created automatically the first time FluxServer.Init runs, or add it yourself beforehand if you need it to exist earlier.
ServerScriptService: FluxServer (ModuleScript) — never put this under ReplicatedStorage (it contains your API key only in memory after Init, but the module must not replicate to clients).

3. Require paths

Server (Scripts / ModuleScripts under ServerScriptService or server context):

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

FluxServer.Init("flux_your_project_key_here")

Client (LocalScripts / StarterPlayerScripts):

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local FluxClient = require((ReplicatedStorage:WaitForChild("FluxClient")) :: ModuleScript)

FluxClient.Init({ flushMs = 150 }) -- optional micro-batch window (50–500 ms clamped in-module)

4. Example test script

Download TestFlux.server.lua — a Script that calls FluxServer.Ping, Init, and sample server logs. Requires FluxServer in ServerScriptService and FluxShared in ReplicatedStorage.