MarshalDocs

Getting started

Five minutes, one time.

1. Add the bot

Use the invite link and choose your server. You need the Manage Server permission.

2. Create a Roblox API key

Go to create.roblox.com, open Credentials and create an API key with the Groups API for your group, with read and write access. Roblox asks for an allowed IP range; 0.0.0.0/0 works. The key must belong to someone who is allowed to rank members in the group.

The bot can only change members ranked below the key owner’s own rank.

3. Connect your group

The server owner runs /setup and enters the group ID and API key. Nobody else can run it. Your key is encrypted before it is stored and is never shown again. You can revoke it on Roblox at any time.

4. Choose who can use it

The owner runs /config staff add to pick the roles that can promote and demote, and /config admin add for the roles that can change settings. Only the owner can change these two lists.

Admins and the owner then run /config settings to set the staff rank limit, a log channel and an announcement channel. The bot needs View Channel, Send Messages and Embed Links in both channels.

5. Check it works

Run /status to see the connected group, then try /setrank on a test account.

Notices from Marshal. Important notices, such as planned maintenance, are sent by direct message to the members of your admin roles. If your server has no admin roles, they go to your log channel instead. Set up at least one of them so you don’t miss anything.