Introduction Last updated: 3 days ago

Welcome to the documentation for the Roblox Moderation Bot. This bot helps you manage your Roblox community by providing moderation tools such as banning users, kicking users, and more.

Installation

Follow the steps below to install the Roblox Moderation Bot.

Bot Installation

Click the link below to invite the bot to your Discord server.

Invite Bot

Configuration

Once the bot is in your server, configure it using the following commands:

  • /Settings - Open the settings for the Server
  • Permissions - Give the bot the necessary permissions
  • Report Ticket - just run the command /send-panel and configure the rest with /settings

API Key Setup

Warning

The API key will not work if the steps are not done correctly. Please follow each step carefully.

  1. Go to create.roblox.com and click on Cloud, then API Keys.
  2. Step 1
  3. Create an API key.
  4. Step 2
  5. Fill out the name and description as you want.
  6. Step 3
  7. Set the permissions to whatever permission is needed from the bot. In this case its User-Restrictions.
  8. Step 4
  9. Add the experience you want to ban users in.
  10. Step 5
  11. Select the operations:
    • universe.user-restriction:read
    • universe.user-restriction:write
    Step 6
  12. Set the security IP address to 0.0.0.0/0.
  13. Step 7
  14. Add it and set expiration to "No Expiration".
  15. Step 8
  16. Save the key.
  17. Step 9
  18. Copy the key and put it in the bot with /settings.
  19. Step 10

For further details about API Keys check out the Roblox Documentation!

Roblox Verification

To verify users in your server, you need to set up the verification panel. Use the command /verification-panel to send the verification panel to the server.

Make sure to set up the verification settings using /verification-settings.

Commands

Here are some useful commands and features of the Roblox Moderation Bot.

Setup

  • /settings - Configure the bot settings.
  • /send-panel - Send the report panel.
  • /verification-panel - Send the verification panel.
  • /verification-settings - Edit the verification gate settings.

Moderation

Roblox Ban

  • /roblox ban <user> <reason> <duration> - Ban a user from the server.
  • Tip

    The duration is in y, M, w, d, h, m, s format, which means you could ban people like this: 5y, 6M, 3w, 8d, 9h, 2m, 1s

  • /roblox unban <user> - Unban a user from the server.

Utility

Asset Management (Not tested (Report Bugs, if they occur))

  • /asset create <assettype> <name> <description> <file>Upload a new asset to the API's owner.
  • /asset view <operationid>View the status of an asset operation.

Database Management

  • (Alpha Version)/datastore get <datastore> <key> - Shows the data saved under the specific Key
  • (Alpha Version)/datastore delete <datastore> <key> - Deletes the whole data of a specific Key
  • (IN PROGRESS)/datastore add <datastore> <key> <value> - Creates a new entry with the given key and value
  • (IN PROGRESS)/datastore edit <datastore> <key> <value> - Edits the data in the specific key with the given value

Server Messaging

  • /server-message <topic> <message> Send a Message to all Servers through the chat.

Example Code you need to put in your game (ServerScriptService):

-- Roblox Lua Script
local MessagingService = game:GetService("MessagingService")

local topic = "exampleTopic" --set this topic to what you will input in the command

local function onMessageReceived(message)
    print("Recieved message: " .. message.Data)
end

MessagingService:SubscribeAsync(topic, onMessageReceived)

Fun

Fun commands will be added here.

Information

  • /userinfo <username> See all information about a Roblox User

Resources

Additional resources for the Roblox Moderation Bot.

Support

If you need help, join our support server on Discord.

Join Support Server

Documentation

Visit our GitHub repository for more detailed documentation.

FAQs

Frequently Asked Questions about the Roblox Moderation Bot.