Connect your Roblox game to Baseplate

Quick start (2 minutes)

1. Create a game in Add a game and copy your bpt_... token.
2. Install the Baseplate Connect Studio plugin and paste the one-step setup code — or download Baseplate.rbxmx and insert it into ServerScriptService.
3. Enable Game Settings → Security → Allow HTTP Requests.
4. Add a server Script in ServerScriptService that calls Baseplate.start.
5. Press Play in Studio. Your setup page will turn green within 15 seconds.

1. Add the module to your game

Option A — Baseplate Connect Studio plugin (one step): save BaseplateConnect.rbxmx into your Roblox Studio Plugins folder, click Baseplate Connect in the Plugins toolbar, and paste the one-step code from your game's Setup page. It drops the Baseplate module and a ready-made BaseplateLoader script into ServerScriptService, turns on HttpService.HttpEnabled, and uploads your 3D place map.

Option B — Manual .rbxmx file: download Baseplate.rbxmx, right-click ServerScriptService in Roblox Studio → Insert from File…, and pick the downloaded file. You should see a ModuleScript named Baseplate (with a Client LocalScript nested inside it).

Leave Client inside Baseplate — when Baseplate.start() runs, it automatically copies Client into StarterPlayerScripts so client FPS, device type, idle time, the Roblox Escape menu, and open ScreenGui windows are reported.

2. Allow HTTP requests

In Roblox Studio open File → Game Settings → Security and turn on Allow HTTP Requests. (If your place isn't published yet, save it to Roblox first, or run game:GetService("HttpService").HttpEnabled = true in the Command Bar.)

Recommended for production: store your token in Creator Hub → Creations → [Your Experience] → Settings → Secrets with the name baseplate_token and read it via HttpService:GetSecret("baseplate_token") so the raw key never sits in plain text inside your place file.

3. Start Baseplate

Create a Script in ServerScriptService:

local HttpService = game:GetService("HttpService")
local Baseplate = require(game.ServerScriptService.Baseplate)

Baseplate.start({
    token = HttpService:GetSecret("baseplate_token"),
    studio = true, -- send data from Studio playtests too (kept separate from live)
})

Or, when testing quickly in Studio, pass the token string directly:

local Baseplate = require(game.ServerScriptService.Baseplate)

Baseplate.start({
    token = "bpt_your_token_here",
    studio = true,
})

All Baseplate.start(options)

Studio playtests vs. live data

Sessions recorded from Roblox Studio (studio = true) are flagged on ingest. They are hidden from all charts by default so your playtests never pollute retention, revenue, or leave-reason numbers. Flip the Studio toggle in the top bar of the dashboard whenever you want to inspect your Studio test sessions.

What's tracked automatically

With only Baseplate.start in place — and zero extra lines of code — you get:

API reference (all optional)

Call these from any server Script after Baseplate.start. Every function is safe to call with invalid or nil arguments — it will never throw or yield your game thread.

Baseplate.event(player, "QuestComplete", {
    quest = "FindTheKey",
    seconds = 42,
    hard_mode = true,
})

-- Server-wide event (no player):
Baseplate.event(nil, "BossSpawned", { boss = "Dragon", level = 5 })

Baseplate.step(player, "1_Spawned")
Baseplate.step(player, "2_OpenedShop")
Baseplate.step(player, "3_BoughtStarterSword")
Baseplate.step(player, "4_EnteredFirstDungeon")

Baseplate.tutorial(player, 1) -- started step 1
Baseplate.tutorial(player, 2) -- reached step 2
Baseplate.tutorial(player, 0) -- finished!

Baseplate.currency(player, "Coins", 100, "QuestReward")
Baseplate.currency(player, "Coins", -50, "BuySword")
Baseplate.currency(player, "Gems", 5, "DailyBonus")

local MarketplaceService = game:GetService("MarketplaceService")

MarketplaceService.ProcessReceipt = function(receiptInfo)
    -- your code that grants the item to the player...

    Baseplate.receipt(receiptInfo)
    return Enum.ProductPurchaseDecision.PurchaseGranted
end

-- 50 / 50 split:
local group = Baseplate.variant(player, "starter_pack", { "control", "cheaper" })
if group == "cheaper" then
    -- show the 49 Robux price
else
    -- show the 99 Robux price
end

-- Custom weights (80% / 20%):
local layout = Baseplate.variant(player, "shop_layout", { old = 80, new = 20 })

-- After DataStore profile is ready and character is spawned:
Baseplate.loaded(player)

Baseplate.mark(player, "OpenedShop")
Baseplate.mark(player, "StartedBossFight")

Baseplate.start({
    token = HttpService:GetSecret("baseplate_token"),
    deaths = "manual",
})

-- Inside your combat / health system:
Baseplate.death(player, "Lava")
Baseplate.death(player, "SkeletonKing")

Baseplate.kick(player, "AFK timeout")

print(Baseplate.status())
-- { started = true, queued = 3, dropped = 0, sent = 4, lastStatus = 202 }

How leave reasons work

When a player leaves, Baseplate evaluates the session from top to bottom and assigns the first matching reason:

Keys & team access

• Universe binding: on the first batch from a live Roblox server, your game is automatically locked to that game.GameId (Universe ID). Batches from any other universe are rejected with 403.
• Rotating tokens: open Settings → Keys on your game dashboard to create a new token and revoke old ones at any time.
• Team access: open Settings → Team to create a one-time invite link for collaborators as a Member or read-only Viewer.

Discord & Telegram alerts

In Settings → Alerts you can connect a Discord webhook or Telegram bot to receive automatic notifications (checked every 5 minutes, with a 2-hour cooldown per alert type):

Update impact

Every session and event is automatically tagged with game.PlaceVersion. On the Updates tab, Baseplate compares each version against the previous one using per-player rates (avg session length, playtime per player, bounce %, errors per 100 sessions, avg FPS, payer conversion %, Robux per player, and D1 retention) so a newly released version with fewer total hours is compared fairly against an older version.

Why it moved

Click any headline metric card on Overview (Active players, Playtime, Avg session, Robux, or D1 retention) to open Why it moved — an automatic breakdown comparing the current period against the previous period across device mix, new vs. returning players, join sources, countries, leave reasons, place version releases, script errors, and payer conversion vs. ARPPU.

Annotations & CSV export

Add a note below the Overview chart whenever you ship an update, run an event, or launch an ad campaign — Baseplate marks it on the timeline and calculates the 24-hour before/after delta. Every table and chart also has a CSV download button.

Data & privacy

• What is stored: within your game, Baseplate records each player's Roblox UserId, username, and display name so you can inspect individual sessions and player histories, alongside country code, device type, FPS/ping, session times, leave reason, purchases, and your custom events.
• What is never collected: Baseplate never reads chat messages, voice, passwords, real names, email addresses, IP addresses, or .ROBLOSECURITY cookies, and never links player profiles across different games.
• Roblox Right to Erasure: open Settings → Privacy on your game dashboard and enter any Roblox UserId (or connect a Roblox Right to Erasure webhook) to permanently delete all sessions, events, and summary rows for that player.

Data retention

Limits & budget

• Roblox HttpService budget: at most 6 HTTP requests per minute per Roblox server (~1.2% of Roblox's 500 req/min limit) — 4 lightweight presence pings + up to 2 event batches.
• Batch size: up to 500 events or 240 KB per batch; the in-memory queue holds up to 6,000 events and drops the oldest if a server is offline for an extended period.
• Custom event fields: up to 16 fields per event; field names are snake_case (max 32 chars) and string values are truncated at 200 chars.

Troubleshooting

AI & CLI (MCP)

Baseplate ships with an official CLI and MCP server so you can ask Claude Desktop, Claude Code, Cursor, Windsurf, ChatGPT, or your terminal questions about your own games and public Roblox charts. Open AI & CLI in the dashboard for a ready-to-paste config and a personal bpt_agent_... token.

npx baseplate login
npx baseplate games
npx baseplate live <gameId>
npx baseplate overview <gameId> --range 7d

HTTP ingest (for custom clients)

The Luau module sends JSON batches to POST /v1/ingest with Authorization: Bearer bpt_... and lightweight 15-second presence pings to POST /v1/presence:

{
  "v": 1,
  "sdk": "0.10.3",
  "game": 1234567890,
  "place": 9876543210,
  "job": "server-job-uuid",
  "ver": 42,
  "seq": 1,
  "dropped": 0,
  "ids": {
    "player_token": "{\"u\":123456,\"n\":\"Player1\",\"d\":\"Player\"}"
  },
  "rows": [
    {
      "t": 1761560000,
      "e": "session_start",
      "p": "player_token",
      "s": "session_id",
      "q": 1,
      "v": 42,
      "j": "job8char",
      "n": 12,
      "d": { "is_new": true, "source": "friend", "country": "US" }
    }
  ]
}