Marshal

Setup guide

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 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.

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 edit settings. Only the owner can change these two lists. Admins and the owner can then use /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. Marshal may also send important notices, such as planned maintenance, to your log channel, or by direct message to your owner and admins if no log channel is set.

Commands

CommandWhoWhat it does
/setupOwnerConnect your Roblox group
/config staff add|removeOwnerChoose staff roles
/config admin add|removeOwnerChoose admin roles
/config settingsAdminsStaff rank limit, log and announcement channels
/config viewAdminsShow roles and settings
/setrankStaffChange a member’s rank: username, then pick a role
/announceAdminsPost to your announcement channel
/lockdownAdminsPause or resume ranking in your server
/support create|status|revokeOwnerGive Marshal support temporary access, or cut it off
/statusAnyoneShow the connected group

The dashboard

Sign in with Discord on the dashboard and pick your server. Staff can change ranks. Admins can also post announcements, use lockdown and change settings. The owner can also choose the staff and admin roles.

Getting help from support

If you’re stuck, the server owner can run /support create (or use the dashboard) to get a one-time code. Share it with Marshal support. It gives them temporary access to look at your settings and help fix things, but they can’t change who your staff and admins are. Every action they take is logged. You can cut off access at any time with /support revoke.

Troubleshooting

“I cannot post in that channel”

Give the bot View Channel, Send Messages and Embed Links in that channel’s own permissions. Channel settings override server ones.

“That API key cannot access the group”

Check the key has Groups read and write for the right group, and that the group ID is correct.

“Staff can only assign up to rank N”

A server manager set a rank limit. Raise it with /config or on the dashboard.

I can’t use /setup or /config

/setup is for the server owner only. /config needs an admin role, and only the owner can change the role lists.

The dashboard says it can’t reach the bot

The bot may be offline, or the site isn’t pointed at the right address. Contact whoever runs this site.