The Template's admin suite

The staff tools every Template game ships with - the top-bar panel, the ; console, every command by area, who may run what, the staff guard, audit, bans and server migrations.

Roblox Template / Template systems catalogue

Every game built from the Blockout Roblox Template ships with a staff tool suite: a draggable admin panel opened from the red shield in Roblox's top bar, a command console on the ; key, and a server that runs typed commands for testers, staff and developers of the Blockout Games group. It doubles as the developer's test harness: any state a feature can reach, a command can reach in seconds. The server, AdminService (src/core/server/Services/AdminService/), decides everything; the panel and the console only send the line typed.

The panel and console are delivered, not shipped. They live in src/core/admin/, built into ServerStorage.AdminSuite, which no client receives; AdminService/Delivery clones it into the PlayerGui of each player whose own role is at least suiteRole, and of a private server's owner, on join and whenever their role changes, and a suspension removes it. A player who cannot use the suite never downloads its modules. AdminController waits until the whole container has arrived (ClientState.admin.suite), and UI/App loads a screen from it the first time it opens. Holding the modules grants nothing: every admin remote checks its caller.

Switching the admin suite on or off

The switch is admin in src/core/shared/Config/Features.luau, on by default. Off, there is no panel, console, shield or command, and MetricsService (the dashboard's server samples) stops.

Who gets the admin suite

Roles come only from a player's rank in the Blockout Games group on Roblox (id 191769851, Config/Permissions.studioGroupId). Nothing in a game's own code, config, data or its own group grants powers; a game's own group can give at most the member role.

Testerrank 252

The console and the panel's Commands and Testing tabs. Acts only on themselves (selfOnly). Commands that change data work for them only in test mode, which they switch on themselves.

Staffrank 253

The whole panel except Effects, moderation, anti-cheat, character and player-support commands. Never another player's data. Never kicked or banned by the anti-cheat.

Developerranks 254 and 255

Every command, including unbans, announcements, server control, staff suspensions and changing other players' data. Never counted by the staff guard.

Everyone in Studio

Config/Admin.studioRole, developer by default, so a developer can test alone. Set it to tester or staff to try what those roles see. It never decides anything in a live server.

Four settings draw the lines: Config/Permissions.suiteRole (tester, the lowest role with the suite), Config/Permissions.staffRole (staff, the rest of the panel and staff alerts), Config/Admin.dataRole (developer, who may change other players' data or buff them) and Config/Admin.viewAsRole (developer, who may view the game as a lower role).

Private server owners

In a private server (game.PrivateServerId set and game.PrivateServerOwnerId not 0, so never a public server or a reserved server the game made), its owner gets the console, the shield and the panel's Commands tab with only the commands in Config/Admin.privateServerOwnerCommands (help, kick, lock, unlock, announce and time by default), whatever their group role.

Not a role

PermissionService never gives it: the owner keeps their role everywhere else. A tester or staff member who owns the server keeps their own commands and adds these.

Only safe commands

Rules/Permissions.ownerMayRun refuses a listed command unless its definition says privateServerOwner = true (it acts on this server alone) and it does not change data, give an advantage, ban, mute or restrain, or hide its output. A game makes its own command available by marking it and listing it in Config/Overrides/Admin.

Only on ordinary players

Protection places the owner above players and members and below testers: a kick never reaches a tester, staff or a developer.

Audited like staff

Every run is in the audit log with the owner as the actor; kick and lock alert any staff in the server. The staff guard counts the owner's kicks and refuses past the limit, but never suspends. A server lock never keeps the owner out.

Opening the admin panel and the console

  • Panel: click the red shield in the top bar. A dot on it means unread alerts.

  • Console: press ; (Config/Admin.consoleKey). ; on a blank line closes it; inside a command it is just a character.

  • In the console, Tab completes, Up and Down walk the history (50 commands), and clear empties it (200 lines kept).

  • With the panel open, F (Config/Admin.flyToggleKey) runs fly me or unfly me.

The console stops accepting input at 500 bytes (Config/Admin.maxLineBytes), the longest line the server accepts. The panel and its command forms cut a line to the same length, and a user search is not sent past 40 bytes (maxUserQueryBytes), so a long pasted reason is never a rejected call the anti-cheat would count against staff. Staff alerts and anti-cheat responses are printed there and shown as toasts. The panel and console are built on their first authorized opening and reused.

The admin panel's tabs

The panel is a floating window: drag it by the title bar, resize it from the corner. The sidebar scrolls, so every tab is reachable on a phone. Each tab has its own role and feature (Tab.luau); the default role is staff.

Dashboard

Server FPS, frame time, client FPS, memory, players, ping, remote traffic and detections, as tiles with a sparkline in a band below their text; two graphs, server FPS with a line at 60 (the scale widens when FPS runs above it, as it does in Studio) and remote calls a second; the busiest remotes; lock, and the announcement box for developers. Server samples come once a second, 120 kept (two minutes). Client FPS is measured on the viewing client only while the tab is shown and never sent to the server. While the Dashboard is the open tab it also shows the lag triage (the lag command below), refreshed once a second: a banner with the worst culprit and a button that runs its command, then calls in by remote and by player, CPU by system, the worst clients and the DataStore requests left.

Players

Search the server, or find any user by id or username in any server, and inspect them. See The Players tab and the inspector.

Commands

Search, a category filter and a form generated from each command's arguments. A player argument is a dropdown of the people in the server, with their headshots and names; a players argument takes several picks, with me, all and others as its first options, and the form sends them as the console's @userId list. In test mode, only the test tools, each on yourself. Testers see it.

Anti-cheat

Suspects, detections over time and every detection. See What staff see of the anti-cheat.

Watchlist

Players worth following, with where they are, Follow and Remove.

Bans

Every ban in force, filterable, with Unban for a role that can lift that ban.

Logs

The server's audit log.

Testing

A switch for test mode, then, while it is on, the test tools, Reset session and snapshots. Testers see it while testMode is on.

Feedback

With platform on: the game's feedback with each sender's picture, display name and @username, filtered by status and category, read only. Staff only.

Platform

With platform on: the game's analytics, who plays, the key's requests and the cache. Staff only.

A game adds a tab by adding a module to src/core/admin/AdminPanel/Tabs/ (lune run new -- tab <Name> writes one there) that returns { name, order, build }, with role = "tester" if testers should see it. A module there runs from PlayerGui, so it reaches the client's modules by where they are at run time (Players.LocalPlayer.PlayerScripts.Client), never through script. A tab loads through Tab.newest(), so only the newest answer shows; a tab that refreshes polls with Tab.poll(scope, context.active, seconds, read), which asks only while the tab is shown and keeps no thread waiting otherwise; a pressable row is Components/ListRow; a destructive press uses Tab.confirm. Padding and gaps come from Theme.spacing, as in the rest of the interface.

The Players tab and the inspector

The search box filters the players in the server as you type (name, display name or id). Find "..." anywhere looks the text up as a user id or username in any server: names, role, ban and watchlist status and a summary of every save slot. Found users stay in the list (the newest ten) for the visit.

Character

Spectate (a local camera change), Bring, Go to, Heal, Respawn, Refresh, Freeze or Thaw, Kill.

Moderation

Mute or Unmute, Warn..., Kick, Server ban..., Ban...

Anti-cheat

Clear score, Exempt..., Watch..., Flag...

Support

Purchases, Saved data, History, Chat log, Give..., Stat..., Run a command...

Below the actions: score, ping, time in server, account age, health, speed, position, muted and frozen, and the last eight detections. The inspector sends only the save's currencies, stats, flags, game passes, sessions, play time and schema version, never receipts or purchase history. A button whose command your role cannot run is hidden. Kill, Kick and every destructive form need a second press within a few seconds.

Purchases, Saved data, History, Chat log and every action ending in "..." open as tool windows over the panel: drag, resize, several at once. Saved data for a present player is read again every two seconds while the window is open and the panel is shown.

How an admin command runs

The client sends the raw line, never parsed values, on the admin.requestRun remote. The server parses it with Util/Command; the autocomplete is a convenience and the server is the authority. In order:

  1. The suite. The caller has suiteRole (staff reads need staffRole). Anyone below the suite calling an admin remote is reported to the anti-cheat as unauthorized_admin, a near-certain exploit.

  2. The rate limit. 4 commands a second per person, bursts of 10.

  3. The command and its role. The command exists and the caller's role is at least its role in Config/Admin.commandRoles.

  4. The arguments. Every argument parses and is in bounds; at most 50 targets (maxTargets).

  5. Self-only and data rules. A tester names nobody but themselves. A changesData or advantage command aimed at anyone else needs dataRole.

  6. The staff guard, for a guard command (below).

  7. The run. In pcall; targets must be present and, for protected commands, of a lower rank than the caller.

  8. The record. The reply goes back, and the line is printed to the server log and kept in the audit log.

An admin command from the console to the audit log. The client sends the raw line on admin.requestRun. The server checks the caller has the admin suite, reporting anyone below it to the anti-cheat, then the rate limit. It parses the line and checks the command's role, the arguments, the self-only and data rules, then the staff guard for moderation commands. The command runs in pcall, the reply goes back to the caller, and the line is written to the audit log, filtered for other staff.

Text other players will see (announcements, warnings, notifications, kick, ban and shutdown reasons, an acflag detail) passes through Roblox's text filter first (TextFilterService, cached and budgeted per staff member; text it cannot filter is never shown). A message players read (announce, globalannounce, notify, warn) is not sent at all when the filter hid any of it: the sender is told and can reword it.

Why a command module that fails does not break the others

The remotes are connected before any command module loads, and each module loads on its own. A module that fails (a typo, a name used twice) is skipped, logged with both sources of a clash, and printed in red in every staff member's console, while every other command works.

Writing a command line

Players

me, all, others, a name or display name (a unique prefix is enough), @userId, and comma lists (bob,alice). The panel always sends @userId.

Users

Arguments of kind user take an id, me or an exact username, never a prefix or a display name.

Numbers

1k, 2.5m, 1b and scientific notation such as 1e6 work.

Durations

30s, 5m, 2h, 7d, 1h30m, perm.

Quotes

A double or single quote groups words only at a word's edges, so apostrophes stay letters (warn bob Don't do that); an unclosed quote runs to the end of the line.

Leave the player out and a command acts on you: give coins 100, fly, speed 50. It puts me in front only when fewer words were typed than the command has required arguments, never when a name was typed and matched nobody (give bobb coins 5 is refused), and never for a command whose last required argument is free text.

How many admin commands there are

Every command is declared once on the server with AdminService.register; the console's completions, the Commands tab's forms and the inspector's actions are built from that declaration. The Template registers 134 commands when every optional system is on. With the Template's default switches, 118 are registered: the 16 that belong to systems off by default (interactionfixture, offline, npcs, platform, studioban, subscriptions, subscription, pushnotify, premium, progression, boosts, playtime, seasonpass, tutorial, ads, adsim) are not. help <command> in game is the full reference.

The role after each command below is the lowest role that may run it (Config/Admin.commandRoles).

General commands

help

Tester. List your commands, or explain one. Aliases cmds, commands, ?.

info

Tester. Version, place, job, uptime and players of this server. Alias server.

whois

Staff. Role, account age, session and anti-cheat score of a player.

afk

Staff. Players in this server who are AFK, and for how long. See the AFK entry of the systems catalogue.

rejoin

Tester. Send players back into this same server. Alias rj. On others it counts as a kick for the staff guard.

badges

Tester. Every badge in Config/Badges: owned, earned but not yet awarded, or not earned. Switch badges.

Moderation commands

kick

Staff. Remove players from this server.

ban

Staff. Ban a user from every server of this game with Roblox's ban API (universe-wide, alt accounts included).

studioban

Developer, with the platform on. ban, then the same ban in every other studio game whose group key allows writing bans, through the platform; answers how many games it reached. Owners see and undo it on the website (Admin, Studio bans). Refused in Studio. Counted as a ban by the staff guard.

unban

Developer. Lift a Roblox ban.

bans

Staff. Every ban in force, or one user's ban history from Roblox. Aliases banhistory, banlist.

serverban

Staff. Kick and keep players out of this server only. Alias sban.

serverunban

Staff. Let a server-banned user back into this server. Alias sunban.

mute

Staff. Stop players sending chat messages and, where the place uses the audio API, speaking. A mute outlives a rejoin to the same server, and a timed mute still ends on time for a player who rejoined.

unmute

Staff. Let players chat and speak again.

warn

Staff. Show one player a warning from staff (on screen for 10 seconds).

lock

Staff. Stop anyone but staff joining this server for 30 minutes (lockMinutes). Alias slock.

unlock

Staff. Let players join this server again. Alias unslock.

Character commands

tp

Staff. Move players to another player. Alias teleport.

bring

Developer. Move players to you.

to

Staff. Move yourself to a player. Alias goto.

freeze

Staff. Pin players in place, re-applied to each new character until thaw.

thaw

Staff. Let frozen players move again. Alias unfreeze.

kill

Staff. Kill players' characters.

respawn

Staff. Give players a new character now, through CharacterService.respawn. Alias re.

refresh

Staff. Give players a fresh character where they stand (CharacterService.respawn with at). Alias ref.

character

Staff. Show a player's character: ready or not, loading, health, Humanoid state, spawns, failed loads and the respawn countdown. Alias charinfo.

char

Staff. Dress players as another user's avatar until they respawn or unchar; the avatar is fetched once and cached (CharacterService.descriptionFor). Alias outfit.

unchar

Staff. Put players' own avatars back.

heal

Developer. Restore players to full health.

god

Developer. Make players' characters unkillable until they respawn; the game's own MaxHealth is kept in the AdminGodMaxHealth attribute.

ungod

Developer. Undo god, restoring the game's own maximum health.

speed

Staff. Set players' walk speed; the anti-cheat follows it. Aliases walkspeed, ws.

jump

Staff. Set players' jump power; the anti-cheat follows it. Aliases jumppower, jp.

fly

Staff. Let players fly through anything: movement keys along the camera, Space up, Q or Ctrl down, Shift for 3 times the 60 studs a second cruising speed.

unfly

Staff. Stop players flying, with a few seconds of movement grace for the fall.

invisible

Staff. Hide players' characters and name tags until they respawn or visible. Alias invis.

visible

Staff. Show players hidden with invisible. Alias vis.

Economy commands

Every currency in Config/Currencies is offered by these, by the console's completions and by the panel's dropdowns.

give

Tester. Add currency to players. Alias add. Reason admin:give.

take

Tester. Take currency from players, down to zero. Alias remove. Reason admin:take.

setbalance

Tester. Set players' balance. Aliases set, setcurrency. Reason admin:set.

balance

Tester. Every balance a player holds. Alias bal.

giveitem

Tester. Add an inventory item to players, as give is for currency. Switch inventory.

takeitem

Tester. Take an inventory item from players: from a stack down to none, or equipment they are not wearing. Switch inventory.

trades

Staff. trades [user]: this server's recent trades, newest first (the trade id, the time in UTC and who gave what), or one user's. The log is the server's memory (Config/Trading.logSize, 50) and is gone when the server closes. Switch trading.

grant

Developer. grant <user> <kind> <id> [amount]: give one reward of any kind (currency, item, boost or title) to any account, online or not. It is checked against the config and the switches, then delivered by account message and paid exactly once as a support claim, in the server the player is in or on their next join. Always the real save.

ads

Staff. A player's rewarded ads: each placement's views today, and whether it can be offered. Switch rewardedAds.

Data commands

stat

Staff. Set a counter in players' saved stats.

flag

Staff. Set or clear a one-shot flag in players' saved data.

resetdata

Tester. Reset players' progress to a new save. Alias wipe. See What resetdata keeps.

grantpass

Tester. Record a game pass as owned (testing and support).

revokepass

Tester. Remove a recorded pass; Roblox re-checks real ownership on the next join.

grantproduct

Tester. Run a developer product's reward without a purchase (testing and refunds); nothing is recorded as a purchase.

lbforget

Developer. Remove a user from every leaderboard, past periods too (erasure requests, cheaters). Switch leaderboards.

codes

Developer. List every redeem code and whether it is live now. Its output and arguments stay out of the audit log (privateOutput). Switch codes.

subscriptions

Staff. Ask Roblox again about a player's experience subscriptions and show each one's status, renewal and last paid period. Switch subscriptions.

saveversions

Developer. A user's recent stored save versions, newest first (version 1 is the save now). See Rolling a save back.

savepreview

Developer. What restoring a listed version would change, value by value.

saverestore

Developer. Write a listed version back as a new version, so it can be undone. Kicks the player from this server first.

saveedit

Developer. Set one allowlisted field (editableSaveFields) in the save of a player who is offline.

Server commands

announce

Developer. Show everyone in this server a message (8 seconds). Aliases a, m.

globalannounce

Developer. Show everyone in every server a message, through the messaging bus. Alias ga.

notify

Developer. Send players a toast of a kind.

time

Developer. Set the time of day (0 to 24).

gravity

Developer. Set workspace gravity (default 196.2); the anti-cheat follows it.

migrate

Developer. Move everyone in this server to a fresh server without disconnecting anyone. Aliases softshutdown, restart. Switch serverMigration.

migrateall

Developer. The same for every server. Alias restartall. Switch serverMigration.

shutdown

Developer. Kick everyone and close this server. The server refuses joins, staff included, from the moment it is run.

privateserver

Staff. privateserver <players>: send the players, in one teleport so they land together, to one new reserved server of this place. Aliases pserver, sendprivate. It is destructive: it never defaults to you, and the panel asks twice. Name me to go too; protected players stay. The staff guard counts it as kicks. The new server is recorded with ReservedServerService, so staff can follow into it. Teleports do not work in Studio.

event

Tester. Preview a seasonal event in this server (start <id> [minutes], stop). Below developer it runs only where no real save is in play (Studio, the testing place, or everyone in the server in test mode), and a join that brings a real save ends it. Switch events.

platform

Staff. The Blockout platform connection: the key's game, the cache and the last error, never the key. Switch platform, off by default. See The staff platform command.

travel

Developer. Send players to another place of the experience. Switch travel.

live

Staff. Every live config key, its Creator Hub name, its value in this server and the build's, and whether the configs loaded. Switch liveConfig. See live config and kill switches.

livetest

Developer. Override one live config key in this server only (<key> <value>, or clear), to try a change before publishing it in Creator Hub; checked like a published value. Switch liveConfig.

errors

Staff. This server's and its clients' script errors, grouped by signature, most frequent first, with counts and first and last seen (list, the default); clear empties the table; throw raises a harmless test error on the server. A client's text is shown filtered for the reader. Switch errorReports, on by default.

Performance commands

For developers, except lag and graphics (testers and up; graphics acts on your own client), overlay (testers) and clients (staff). memory, instances, network and physics take an optional client or server (default client).

lag

Testers and up, read-only. What is over budget on this server right now, worst first, each with its evidence and the command that looks closer: a slow server heartbeat, a system over its CPU budget or one long call, one player flooding a remote, data sent per player, memory growing too fast, a slow physics step, a DataStore request type about to throttle, a device tier's frame time or memory, and high ping. With nothing over budget it says so, with the headline numbers. The thresholds are Config/Perf.triage and Config/Perf.budgets. In Studio a client's memory includes Studio's own, so the client memory budget is not compared there and the headline says so; live servers keep the check. For trends across every server, use the Creator Hub's performance dashboard.

overlay

Tester. Show or hide your live performance overlay, top right: FPS, frame-time p50/p95/p99, render CPU and GPU frame times in milliseconds, ping, the server's heartbeat time, memory, instances and network rates, refreshed twice a second. F7 (Config/Perf.overlay.key) toggles it too for anyone with the suite. Off by default, never shown to players, nothing runs while it is hidden.

clients

Staff. Every client's performance reports: the worst five clients by frame time (newest p50 and p95, the worst p95 kept, memory, ping, graphics level, viewport, age) and one row per device tier (phone, tablet, desktop, console, VR). Switch clientPerf. See Client performance reports.

perf

Measure your own frame time: hide parts of the scene on your client, one at a time, and report what each saves (full or quick), with CPU and GPU frame times in milliseconds.

serverperf

The latest server health sample: heartbeat FPS, memory, ping, players and remote calls.

clientperf

Sample your rendered frames: mean FPS, median, p95 and worst frame time.

memory

Total process memory and memory categories in MB.

instances

Instances in memory, physics primitives, moving primitives and contacts, pending lifetimes (Roblox/Lifetime), each pool's free, in-use, made and discarded counts (Util/Pool), and the world tweens the server has published; on a client, world sounds playing, culled and dropped, world tweens playing and snapped, and animation tracks loaded.

network

Data and physics send and receive rates in KB/s.

physics

Physics FPS, step time, scheduler work, moving primitives and contacts.

renderstats

Your last frame time, draw calls, triangles, viewport and graphics quality.

streaming

Your client's streaming radii and the streaming baseline's integrity, stream-out, model, signal, character-destroy and physics settings (those scripts cannot read show unavailable), the persistent models loaded against the budget, whether gameplay is paused, and the replication focus.

startupperf

Bounded startup, loading or server sync counters (client or server).

perfscenario

A reversible Studio-only menu or camera fixture, or manual respawn observation (menu, camera, respawn, stop).

perfstop

Cancel your running probe or sample and restore what it changed.

graphics

Force your own graphics tier for this session (auto, low, medium or high; auto returns to the chosen one). Tester and up. See the Graphics quality entry in the systems catalogue.

net

Remote calls in and sends out a second, by remote, player and player on a remote (show), or estimate payload bytes per remote for a minute (capture, stop). See Finding what makes a server lag.

leaks

The server's memory trend (total, instances, memory categories while tracking is on) and anything growing faster than Config/Admin.leaks allows.

budgets

Each DataStore request type's budget now and the store calls this server made in the last minute, plus its MemoryStore request units by structure and operation beside the quota this server's players bring, and its cross-server messages per topic (published, received, refused) with this server's publish limit.

cpu

CPU milliseconds per second by labelled system, busiest first, with calls and the longest single call: cpu start begins a capture, cpu reports it so far, cpu stop freezes it. Add client (cpu show client) for your own client, reported to your console and Output. The labelled total of the last second is always shown. Labels come from Util/FrameBudget, which wraps every per-frame handler and names it in the MicroProfiler too; FrameBudget.snapshot() is the same data for code.

npcs

NPC navigation's crowd fixture: build it in front of you (fixture, with an optional agent count: NPCs walking between stations, which every player sees), report its agents, path queue, requests, retries, replans, compute and wait times and failures (stats), or remove it (clear). Switch npcNavigation.

stress

Load the server, or your own client, on purpose: parts, tweens (the same blocks bobbing through server world tweens), ui (labels on your screen), standins (idle R15 rigs) or remotes (that many messages a second to you), each with a count capped in Config/Perf.stress; asking again replaces that kind, and clear removes yours. Leaving or losing the suite removes them too. Only in Studio, or in test mode where advantages are allowed.

perfrecord

Record the server while you run a scenario: start, then stop prints a capture (heartbeat interval and work time, memory, instances, network, tagged with Config/Game.version and the place version); list names the last few on the server and list <n> prints one again. Works on live servers; one recording at a time.

Client performance reports

While clientPerf is on (the default, with admin), every client times its frames for ten seconds once a minute and sends a small summary through perf.requestReport: frame-time p50 and p95, memory, the input in use, VR or console, the saved graphics level and the screen size. The server measures ping itself. It refuses wrong types, clamps every number, accepts two reports at once and then one per 30 seconds, and keeps the last ten per player in memory until they leave. Each answer is the time until the next report: a minute while someone with the suite is in the server, five minutes while nobody is. A sample during which the window lost focus is not sent. Reports are untrusted and read only by staff.

ClientPerfService.summary() returns the same table clients prints, typed ClientPerfService.Summary (Rules/ClientPerf.Summary):

clients

How many players have at least one report.

worst

Up to five clients, the highest peakP95Ms (the worst p95 in the kept reports) first: userId, name, tier, at, reports, p50Ms, p95Ms, peakP95Ms, memoryMb, pingMs, quality, viewportX, viewportY, from the newest report.

tiers

One row per device tier with clients, in the order phone, tablet, desktop, console, VR: clients, the medians p50Ms, p95Ms, memoryMb and pingMs, and worstP95Ms.

A touch screen whose short side is under 600 pixels is a phone, any other touch screen a tablet. Every limit is in Config/Perf.reports; the overlay's key and timings are in Config/Perf.overlay.

Comparing two builds

Save two perfrecord captures to files and run lune run perfdiff <before> <after>. It prints every metric with its change and better, worse or same (within Config/Perf.record.tolerance), then holds the later capture to the budgets in Config/Perf.budgets (the measurable rows of docs/engineering/Performance.md) and exits non-zero when one is broken, so it can gate a release. A capture is plain key value lines starting perfcapture 1; a key only one capture has shows as added or removed. Client frame stats are not in a capture yet: run clientperf during the recording.

Anti-cheat commands

suspicion

Staff. A player's anti-cheat score and recent detections. Aliases ac, sus.

acclear

Developer. Forget players' score and history (a false positive).

acexempt

Developer. Excuse players' movement for a while, at most 3,600 seconds (testing, events).

acflag

Staff. Record a detection by hand (to test alerts, or report what you saw).

watch

Staff. Put a user on the watchlist: staff in every server hear when they join.

unwatch

Staff. Take a user off the watchlist.

follow

Staff. Join the server a user is playing in, any server of this game in any of its places, reserved servers included. Alias joinserver. A public server is joined by its job id; a reserved server, which refuses a job id, by the access code or ReservedServerId ReservedServerService recorded for it (see the Travel entry of the systems catalogue). The reply says why when it cannot go: not in a server of this game, in a reserved server nobody recorded, or Roblox's own refusal (also as a toast when Roblox refuses after the teleport started).

suspicion, acclear, acexempt and acflag need the antiCheat switch; watch, unwatch and follow stay with it off.

Staff commands

staff

Tester. Who in this server is staff or a tester. Alias onduty.

chatlog

Staff. A player's latest chat messages in this server (30 kept in memory, chatLogSize), filtered for you. Alias chats. Under Roblox's platform-integrated chat (required from May 2027), Roblox hides message text from scripts, so nothing is kept and the command says so, pointing you to Roblox's own chat window and its Report menu.

history

Staff. What staff did about a player in this server, newest first. Alias actions.

suspend

Developer. Suspend a staff member's or tester's powers in every server until reinstated.

reinstate

Developer. Restore a suspended member's powers. Alias unsuspend.

suspensions

Developer. Every suspended staff member: who, why, by whom, and the evidence.

Testing commands

Testers use these on themselves; the ones that change data work only in test mode.

testmode

Tester. Switch test mode on or off for yourself, or see whether it is on. Alias tm.

subscription

Tester. Force an experience subscription on or off in this server, or real to let Roblox decide again. on pays one forced period. Below developer only where test mode allows advantages; it ends with test mode. Switch subscriptions.

premium

Tester. Turn Premium perks on or off for players in this server whatever Roblox says, or real to let Roblox decide again. Below developer only where test mode allows advantages. Switch premium.

progression

Tester. Add XP without the prestige bonus (xp <amount>), or reset the level and prestiges (reset; currencies and upgrades a prestige reset are not given back). Switch progression.

boosts

Tester. Give some of a boost to use (give <boost> [count]), or clear one boost, or every boost held and running (clear). Switch boosts.

playtime

Tester. Make the next session playtime reward ready now (ready), or start the session's count again (reset). Switch playtimeRewards.

seasonpass

Tester. Add season points (points <amount>), unlock the premium track without a purchase (premium), or reset this season's points and claims (reset; a bought premium track is kept). Switch seasonPass.

tutorial

Tester. Restart the first-time tutorial from its first step, skip it or finish it. Switch tutorial.

testreset

Tester. Put your test copy back the way it was when test mode started.

snapshot

Tester. Remember this point in your test session by name (up to 5), or list them.

restore

Tester. Go back to a snapshot of your test session.

daily

Tester. Daily reward streak: reset (never claimed) or ready (claimable again, streak kept).

codereset

Tester. Forget that players used a code (or every code); below the data role it takes only all.

referral

Tester. Credit players with a new friend from you, as if your invite brought them in.

community

Tester. Show players Roblox's favorite or group prompt now, whatever the timing; it only moves that prompt's cooldown. Below staff it shows it only to yourself. Switch community.

quest

Tester. Finish a quest (ready to claim) or start it again.

upgrade

Tester. Set players' level of a shop upgrade (0 removes it).

inventoryfixture

Tester. Grant one configured inventory item to your sandbox only. Switch inventory.

interactionfixture

Developer. interactionfixture spawn|clear [style]: spawn one isolated lever per shipped prompt style side by side on the ground ahead of you, or one in the style named, or clear them; no reward or save changes. Each lever is a post with a handle, labelled with its style's name; a hold tilts the handle the other way and changes its colour. It belongs to the interactions kit, so it needs only the interactions switch, and it refuses when the game registers its own activate action.

offline

Tester. Set what a player's save earns per hour while away (rate <amount>), or claim now as if the player had been away that many minutes (away <minutes>), with the same cap, pending pay and toast as a real return. In test mode both act on the copy. Switch offlineProduction.

pushnotify

Developer. Show Roblox's notification opt-in prompt to players now, without the cooldown (prompt), or send them a kind from Config/ExperienceNotifications now (send <kind>), which counts toward their limit. Switch experienceNotifications.

title

Tester. Keep a title in a player's save (grant) or take a kept one back (revoke). In test mode it writes the copy. Switch titles.

adsim

Tester. Grant a rewarded-ad placement's reward as if an ad was watched, only in Studio or for a player in test mode. Switch rewardedAds.

What resetdata keeps

resetdata (alias wipe) gives a player a fresh save slot but keeps createdAt, lastSeenAt, sessions, playtimeSeconds, purchases (receipts, so a retried receipt is never granted twice, product counts and the purchase history), gamepasses and gifts (orders, and gifts paid for others but not yet handed over): the same purchase ledger a saverestore keeps. Settings, stats, flags, quests and shop upgrades go back to the template; balances go back to each currency's starting amount through CurrencyService.set(..., "admin:resetdata"). It does not touch the account data: reset the daily streak with daily <players> reset and used codes with codereset <players> all.

Rolling a save back

Roblox keeps every write to a save as a version for 30 days. Four developer commands use them; each takes a user id or exact name and an optional slot (default 1), refuses staff of equal or higher rank, and spends one token of the caller's own budget. In Studio, whose mock store keeps no versions, saveversions, savepreview and saverestore refuse: try them on the testing place.

  1. saveversions <user> lists the newest 10 versions (saveVersions), newest first, with when each was written, sessions, playtime and last seen.

  2. savepreview <user> <n> compares version n of that list with the save now: at most 25 lines like stats.wins: 40 -> 12 (saveDiffLines), then "and N more". A number stays valid for 15 minutes (saveListMinutes).

  3. saverestore <user> <n> writes it back. A player in this server is kicked first ("Support is restoring your save") and you run it again once their save has closed; a player in another server is refused until they leave.

Every write goes through a ProfileStore session of its own, so it respects the session lock and lands as a new version: after a restore, version 2 is the save from just before it, and saverestore <user> 2 undoes it. The stored save is migrated exactly as a load does, and a save this build cannot read is refused. A restore keeps the current purchases, gamepasses and gifts, so a retried receipt is never granted twice and nothing bought since is lost (products bought since keep their receipts but not their rewards; grantproduct gives those back). Account data and leaderboards are not touched.

saveedit <user> <field> <value> sets one field in the save of a player no server holds, through the same migration and a type check: by default any stats.* number and flags.* boolean. A game adds its own in Config/Overrides/Admin.luau (editableSaveFields, an exact path such as "tutorial.step" or a map's "name.*", each "number" or "boolean"). Currencies are never editable this way; there is no raw JSON. A write alerts the developers online, and every run is in the audit log.

Which role runs which admin command

Config/Admin.commandRoles is the one table that sets a built-in command's role; no built-in command sets its own. A game's own command may set role too, and when it is also in the table the stricter of the two wins. A command in neither gets defaultCommandRole, developer (that is how travel is developers').

Commands that change data or give an advantage

Commands marked changesData (give, take, setbalance, stat, flag, resetdata, grantpass, revokepass, grantproduct, giveitem, takeitem, grant, lbforget, saverestore, saveedit) or advantage (fly, invisible, refresh, heal, god, speed, jump, tp, bring, to, acexempt, perf, premium, subscription) follow two rules:

  • On anyone else they need dataRole (developer), so nobody below developer can mint currency, edit a real save or buff a friend. Staff moderate with to, freeze and follow rather than tp and bring.

  • On yourself, changesData needs test mode below developer, and advantage below staff needs test mode where it allows advantages (Studio, the testing place, your own private server, a private server where every other player is staff or in test mode).

A command aimed at another player who is in test mode answers with their name and "(test copy only)". A game command that changes progression, items or currency must set changesData.

Protected targets

Protection is the default: a command acts only on players of a lower rank than the caller. Only commands that help or do not harm opt out: give, giveitem, heal, god, fly, invisible, grantpass, grantproduct, notify, acclear and acexempt. Undoing another's state stays protected (ungod, visible, thaw, unmute), so a developer's god or invisibility is theirs to end. A player whose group lookup has not succeeded yet cannot be targeted.

When a player drops below the suite (a suspension), what commands left on them ends: flight, invisibility, and god, speed and jump.

The staff guard and suspensions

Commands marked guard are counted per staff member, one per user they can act on other than themselves, in this server or not. Past a limit the command is refused and the staff member is suspended in every server until a developer reinstates them. Developers are never counted (staffGuard.exemptRole). The limits are server-only, in src/core/server/Config/Admin.luau (staffGuard.limits), so no client can read how many actions are too many.

Action countedBurstThen per minute
ban, studioban51
serverban51
kick (and rejoin, privateserver)103
mute103
freeze, kill and respawn103

acflag counts as a ban when the anti-cheat bans (banAt above 0) and as a kick otherwise. The counts live in a game-wide value per member (staffGuard/<userId>), so rejoining or another server never resets them. Developers in the server get an alert naming the limit, and suspensions <user> shows the last 15 audit lines that led to it (evidenceLines), ending with the refused line. Each server re-reads the saved suspensions every 60 seconds (refreshSeconds).

The audit log

Every command run is printed to the server log as typed, with ok or refused: and the refusal's reason, and kept in the audit log: the last 300 entries per server, in memory (auditLogSize). The Logs tab, history and a suspension's evidence show it to other staff. What they read is filtered, as Roblox requires for text one user shows another: a line that parses is rebuilt from its parsed values (players as @userId, free text through the text filter); a line that does not parse is filtered whole. The record is written beside the reply, so the filter never delays the answer. A command marked privateOutput (codes) is audited, but its output and arguments are hidden ("(output hidden)").

The ban list

Roblox keeps bans (Players:BanAsync) but cannot list them in game, so the Template keeps its own record: every ban made with ban or by the anti-cheat is added to a list saved as one shared value (adminBans, the newest 200 kept, banListSize; expired bans drop first). unban removes an entry. The Bans tab and bans with no argument show it, then this server's serverbans; when the list cannot be read, bans says so instead of answering that nobody is banned. Bans made outside the game (the Creator Dashboard, Open Cloud) are not in it; bans <user> asks Roblox for one user's history.

Locking a server

lock keeps everyone below staff out of the server for 30 minutes, then the server unlocks itself and staff get an alert ("The server lock ran out; anyone can join again."). lock again restarts the count; unlock ends it sooner. The join gate is connected first in AdminService.init, so a failed start can never skip it.

Viewing the game as a lower role

A developer can choose View as in the panel's title bar and pick a role below theirs (staff, tester, member, player). The admin suite then treats them as that role everywhere it decides: tabs, the catalog, every command check and test mode. The top bar's VIEWING AS ... button goes back with one click. Their published role, chat tag and protection stay real, nothing is saved, and each change is in the audit log (viewas staff, viewas back), at most two changes, then one every two seconds.

Server migrations

When a server closes, its players are moved instead of disconnected: a "Moving you to a fresh server..." notice, a few seconds in a holding server, then back in the game with everyone they were playing with, on the newest version. "Shut down all servers" and "Migrate to latest update" on the Creator Dashboard no longer throw players out. MigrationService owns it; the switch is serverMigration, on by default.

The server closes

This server, from BindToClose when Config/Migration.onShutdown is true. It waits up to 25 seconds for players to leave; Roblox allows 30.

migrate

This server, on demand; staff are alerted.

migrateall

Every server: publishes on the messaging bus's BlockoutMigrateAll topic, and every server, this one included, migrates when it hears it.

  1. Leaving. The server reserves a private holding server and teleports every player there together, with a marker naming that server under the teleport data key blockoutMigration. Every client fades the loading screen back in ("Migrating server"). The teleport starts a second and a half later. Every three seconds it sends anyone still there; a player whose teleport fails 3 times (attempts) is kicked with a message asking them to rejoin.

  2. Holding. The holding server loads no saves. Once the earliest arrival has waited 8 seconds (holdSeconds), so the old servers are gone, everyone is teleported back together.

  3. Back. Roblox picks a public server, after an update one on the new version.

A server migration. When a server closes or staff run migrate, the server reserves a private holding server and teleports every player there with a marker naming it, behind the loading screen. The old server saves each player as they leave. The holding server loads no saves; after 8 seconds it teleports everyone back together into a public server Roblox picks, on the newest version. A teleport that fails 3 times asks the player to rejoin.

Nothing is saved by the migration itself: a teleport is a leave, so the old server ends the session and saves as usual, and the holding server never starts one. A forged marker cannot turn a public server into a holding server: an arrival must be in a reserved server whose PrivateServerId the marker names.

Finding what makes a server lag

serverperf says a server is slow; MetricsService keeps the accounting that says why, on the dashboard's one-second tick, and net, leaks and budgets read it.

  • Network. MetricsService counts client calls in per remote and per player itself (RemoteGuard.setReceiveCounter), so net and the dashboard work with antiCheat off. Remo has no outbound hook, so on the server RemoteGuard.serverOnly() wraps each server-to-client remote's fire methods and counts every send: a direct send per recipient, a broadcast once per remote. A query's answer counts as a send to its asker under the query's name. Sync patches are sync.patch. Rates cover the last Config/Admin.traffic.windowSeconds (10). A capture estimates payload bytes from the values sent; Roblox has no per-remote byte counter, so these are estimates for comparing remotes, never wire bytes.

  • Memory. A sample every Config/Admin.leaks.sampleSeconds (10): total MB, instance count and, while the engine's memory tracking is on, each DeveloperMemoryTag category. A least-squares trend over the last minutes (10) faster than mbPerMinute (3) or instancesPerMinute (500) alerts developers in the server, once per measure per realertMinutes (15). A server filling with players grows too: read an alert beside the player count.

  • Store requests. DataService counts each request it makes by the DataStore request type it spends, and the MemoryStore module the request units of every MemoryStore call (the engine reports no MemoryStore quota); budgets shows them beside GetRequestBudgetForRequestType. ProfileStore's own auto-saves are in the budget, not the counts.

With nobody looking it costs an increment per call and one pass a second; payload sizes are estimated only during a capture. Tools read the same data through MetricsService.traffic(), leaks() and budgets(); the shapes are documented in the Template's docs/systems/Admin.md ("Diagnostics").

The admin suite's rate limits

Commandsper person

4 a second, bursts of 10 (commandsPerSecond, commandBurst).

Panel readsper staff member

6 a second, bursts of 12: catalog, feed, inspector, ban list, watchlist (readsPerSecond, readBurst).

Purchase lookups

Bursts of 3, then 0.1 a second; an answer is reused for 30 seconds (purchaseBurst, purchasesPerSecond, purchaseCacheSeconds).

User lookups

Bursts of 5, then 0.2 a second; not cached, so Look up again shows a new ban (lookupBurst, lookupsPerSecond).

Save supportper staff member

Bursts of 4, then 0.1 a second: saveversions, savepreview, saverestore, saveedit (saveToolBurst, saveToolsPerSecond).

View as

Two changes, then one every two seconds.

Adding an admin command to a game

  1. Register it from the owning service

    In the service's init(), call AdminService.register with a name, a category, a description, Args-typed arguments and a run function. Set changesData if it changes progression, items or currency, feature if it belongs to an optional system.

  2. Give it a role

    Add it to Config/Admin.commandRoles, or set role on the definition. Without either it is developers' only.

  3. Try it in the console

    It appears in the console's completions, the Commands tab and, if its first argument is a player, the inspector, with no interface code.

A game's own command
AdminService.register({	name = "unlockarea",	category = "World",	description = "Unlock an area for players.",	args = { Args.players(), Args.keyOf("area", Areas) },	changesData = true,	run = function(context, userIds, areaId)		return AdminService.eachTarget(context, userIds, { verb = "Unlocked", protect = false },			function(target)				local result = AreaService.unlock(target, areaId, "admin:unlockarea")				return result.ok, if result.ok then nil else result.reason			end)	end,})

The Template's admin-command skill walks through the same steps.

Where the admin suite lives

  • src/
    • core/
      • server/
        • Services/
          • AdminService/
            • init.luauthe service: execute, staff alerts, the join gate, onRevoked's triggers and the lifecycle; re-exports the parts below
            • Targets.luauroles (View as, the private server owner), protected targets, eachTarget
            • Registry.luauregister, who may run what, the catalog, onRevoked, loading Commands/
            • Audit.luauthe audit log and filterText
            • Remotes.luauthe panel's remote handlers (catalog, run, feed, inspector, bans, watchlist, View as, lookups) and their rate limits
            • Api.luauthe types a command module receives
            • Args.luauargument builders (players, currency, keyOf, duration, ...)
            • StaffGuard.luauthe staff guard's counts, merging its limits from the server Config/Admin
            • Delivery.luauclones the panel and console into the PlayerGui of those who may use them
            • BanList.luauthe saved ban list
            • Watchlist.luauthe shared watchlist and join announcements
            • Moderation.luaumutes, freezes, the server lock, server bans, chat logs
            • Commands/the built-in commands, one module per category
          • MetricsService.luauserver health once a second for the dashboard; the network, memory and store-request accounting
          • ClientPerfService.luauclient performance reports, clients, the overlay's server heartbeat
          • LagTriageService.luaulag and the Dashboard's triage
          • MigrationService.luauserver migrations
        • Config/
          • Admin.luauserver-only: the staff guard's staffGuard.limits
      • admin/built into ServerStorage.AdminSuite, delivered only to those who may use it
        • AdminPanel/the panel, Tab.luau, its tabs (Tabs/) and tool windows
        • AdminConsole.luauthe console
      • shared/
        • Config/
          • Admin.luauconsole key, limits, commandRoles, dataRole
          • Permissions.luauthe studio group, ranks and roles
          • Migration.luaumigration timings and messages
        • Rules/
          • Traffic.luaurolling per-second windows, ranking, payload size estimates
          • Leak.luaumemory growth per minute and leak suspects
          • LagTriage.luauthis server's numbers ranked into culprits
        • Util/
          • Command.luautokenizing, parsing, selectors, completions
      • client/
        • Controllers/
          • AdminController.luausuite gating, catalog, feed polling, alerts
          • PerfOverlayController.luauthe performance overlay and the client's reports
          • DiagnosticsController/the perf probe, clientperf, client reports for cpu and the snapshots, perfscenario, stress ui
        • UI/
          • Topbar.luauthe shield, version and FPS readouts
          • Screens/
            • PerfOverlay.luauthe performance overlay

The Template's own notes are docs/systems/Admin.md, docs/systems/Permissions.md and docs/systems/Server Migration.md.

Updated