CF Rank Bot • Docs
CF Rank Bot • Overview

About CF Rank Bot

CF Rank Bot is a comprehensive platform for Roblox group automation. It connects your community across Discord, a web portal, and an in-game API so you can manage ranks and review actions from wherever you work best.

Discord Bot Web Portal In-Game API Resources

In-Game Rank Center

We provide a pre-made Roblox Studio place file that integrates directly with CF Rank Bot's API. This allows you to set up an in-game ranking experience instantly.

⚠️ Important: Ensure you have generated your unique API Key via the Portal Profile before starting.

Download the Place File
Contains the configured GUI and Local Scripts necessary to connect to the bot.

Download Rank Center (.rbxl)

Installation Instructions

  1. Security Settings: In Roblox Studio, open Game Settings -> Security. Enable both Allow HTTP Requests and Enable Studio Access to API Services.
  2. Configuration:
    • In the Explorer window, navigate to ReplicatedStorage -> CFRankBotController.
    • Open the Module Script named CF_Config.
    • Paste your API Key and your Group ID into the configuration slots provided.
  3. Customize Ranks: Open the CFRankBotController script and follow the instructions within RankConfig to set up which ranks are displayed and manageable.

Discord Bot Features

Ranking & User Commands

For users who prefer to work directly within Discord, our bot provides intuitive slash commands for all core ranking functions. This allows for quick actions without ever leaving the server.

  • /promote & /demote: Change a user's rank one step at a time.
  • /setrank: Opens an interactive dropdown to select a specific rank for a user.
  • /lookup: Provides a detailed profile of a Roblox user, including their in-group rank, allies, enemies, and more.
  • /ranks: Displays a list of all available roles in the configured group.
  • /groupinfo: Fetches and displays public information about a Roblox group.

Server & Permission Management

Server owners and authorized administrators have full control over the bot's configuration within their server. Our staff also has these permissions if you invite them into your server for support reasons.

  • /setgroup: Securely links your Discord server to a specific Roblox Group ID.

    • Use /rankrole add to assign the Discord roles that will have permission to rank members. This determines who can perform ranking actions. Multiple roles can be added.

    Use /rankrole remove to remove the Discord roles that will have permission to rank members.

    Use /rankrole list to list the Discord roles that will have permission to rank members.

  • /setlogchannel: Sets the channel where all ranking actions will be logged for transparency.
  • /authorize & /deauthorize: A manual whitelist system to grant or revoke ranking permissions to specific individuals, regardless of their roles (useful for rank gamepasses or special cases).

Web Portal Features

User Experience

Our web portal allows for a more visual and centralized management experience.

  • Verification: When you log in with Discord you will be required to verify your Roblox account so the bot knows who you are.
  • Group Selection Dashboard: A simple dashboard that displays all groups and servers you are authorised to rank in or view the audit logs for.
  • Rank Management Panel: A real-time interface to promote, demote, or setrank users, showing the target user's current rank and avatar before an action is taken. See Rank Management.
  • Profile Management: Users can manage their linked Roblox account and generate/delete secure API keys for their scripts and applications via the profile page.
  • Audit Logs: For higher ranks within a group to reverse ranks or address abuse; view all rank requests for your group and where they came from via the audit page. The anti admin abuse in the near future will be improved and be able to rank multiple back to their rank if an AA was to happen

Admin & HR Portals

We have internal portals to provide you with support and to manage the platform.

  • Logistics Portal (LR/MR): For lower/middle ranks within our staff team.
  • HR Portal (HR): Mostly meant for debugging but also used to manage staff and higher-level configuration.

In-Game API

The HTTP API allows you to perform in-game ranking for things such as auto-trainers, admin rank commands, or whatever your experience requires. More information can be found at Extended API information

Informational Endpoints (GET)

  • GET www.botranker.uk/api/v1/group/roles – Returns a JSON list of all roles in a specified group.
  • GET www.botranker.uk/api/v1/user/rank – Retrieves a specific user's rank name and ID in a group.

Action Endpoints (POST)

  • POST www.botranker.uk/api/v1/promote – Promotes a user by one rank.
  • POST www.botranker.uk/api/v1/demote – Demotes a user by one rank.
  • POST www.botranker.uk/api/v1/setrank – Sets a user's rank to a specific ID.

Support Information

You can get support by joining our Discord server and creating a ticket describing your issue or question.