Official Guide

Commands & permissions

Explore the complete commands and permissions documentation below for RankForge.

โŒจ๏ธ Commands

All commands use the /rank base (aliased as /ranks).

Player Commands

CommandPermissionDescription
/rankrankforge.rank.useOpen the animated rank tree GUI
/rank uprankforge.rank.upAttempt to rank up to the next rank
/rank progressrankforge.rank.progressShow a progress bar and requirement breakdown
/rank nextrankforge.rank.nextShow your next rank's display name
/rank currentrankforge.rank.currentShow your current rank
/rank requirementsrankforge.rank.requirementsList unmet requirements for the next rank
/rank historyrankforge.rank.historyView your last 10 rank changes
/rank xprankforge.rank.useView your vanilla XP level and progress
/rank lang set <code>rankforge.rank.langSet your preferred language
/rank lang listrankforge.rank.langList all available languages
/rank lang resetrankforge.rank.langReset to the server default language
/rank versionrankforge.rank.system.versionShow plugin and system information
/rank help(none)Show the help screen

Admin Commands

CommandPermissionDescription
/rank editorrankforge.rank.editorOpen the admin rank editor GUI
/rank editor <rankId>rankforge.rank.editorOpen the editor for a specific rank
/rank editor dragrankforge.rank.editor.dragOpen the drag-and-drop slot editor
/rank editor reloadrankforge.rank.editorHot-reload ranks.yml from the editor
/rank createrankforge.rank.createCreate a new rank via chat prompts
/rank create <id>rankforge.rank.createCreate a new rank with a specific ID
/rank delete <id>rankforge.rank.deleteDelete a rank (prompts for confirmation)
/rank remove <id>rankforge.rank.deleteAlias for /rank delete
/rank set <player> <rank>rankforge.rank.setSet a player's rank (online or offline)
/rank force <player> <rank>rankforge.rank.forceForce-set a rank bypassing all checks
/rank bypassreq <player> <requirement>rankforge.rank.bypassreqMark a single requirement (e.g. money, playtime) as satisfied for a player, without force-setting their rank
/rank reset <player>rankforge.rank.resetReset a player's rank to the default
/rank xp set <player> <amount>rankforge.rank.xp.adminSet a player's tracked experience
/rank xp add <player> <amount>rankforge.rank.xp.adminAdd to a player's tracked experience
/rank playerlistrankforge.rank.playerlistOpen the player data GUI (browse all players)
/rank reloadrankforge.rank.reloadFull plugin reload (config + ranks + lang)
/rank statsrankforge.rank.statsShow system statistics in console
/rank securityrankforge.rank.securityShow anti-abuse system status
/rank debugrankforge.rank.debugShow your personal rank debug information
/rank sound <name>rankforge.rank.soundTest a sound effect by name

Command Examples

# Player ranks up
/rank up

# Admin views Steve's rank info
/rank debug     # (run as Steve, or use /rank set to inspect)

# Admin sets Steve's rank
/rank set Steve Veteran

# Admin force-sets rank without checking requirements
/rank force Steve Elite

# Admin waives a single requirement for Steve (e.g. he's grinding playtime elsewhere)
/rank bypassreq Steve playtime

# Admin resets Steve to the default rank
/rank reset Steve

# Admin gives Steve 500 tracked XP
/rank xp add Steve 500

# Admin creates a new rank
/rank create
/rank create Builder

# Admin deletes a rank
/rank delete Builder

# Reload config and ranks after editing files
/rank reload

/rank set and /rank reset support offline players โ€” the change is stored in the database and applied the next time that player joins.

/rank bypassreq records the waived requirement directly on the player's stored data, so it survives /rank reload, server restarts, and reconnects. It clears automatically the moment the player successfully ranks up, or if an admin resets their data from the Player Data Editor GUI.


๐Ÿ”‘ Permissions

Player Permissions

PermissionDefaultDescription
rankforge.use.*trueGrants all player permissions (wildcard)
rankforge.usetrueOpen the rank GUI (/rank)
rankforge.use.uptrueRank up (/rank up)
rankforge.use.currenttrueView current rank (/rank current)
rankforge.use.nexttrueView next rank info (/rank next)
rankforge.use.progresstrueView rank progress bar (/rank progress)
rankforge.use.requirementstrueView rank requirements (/rank requirements)
rankforge.use.historytrueView rank history (/rank history)
rankforge.use.helptrueView command help (/rank help)
rankforge.use.langtrueChange language (/rank lang)
rankforge.use.versiontrueView plugin info (/rank version)
rankforge.use.xptrueView personal XP info (/rank xp)

Administrator Permissions

PermissionDefaultDescription
rankforge.admin.*opGrants all administrator permissions (wildcard)
rankforge.admin.reloadopFull plugin reload (/rank reload)
rankforge.admin.editoropOpen the admin rank editor (/rank editor)
rankforge.admin.playerlistopView and edit all player data (/rank playerlist)
rankforge.admin.createopCreate a new rank (/rank create)
rankforge.admin.deleteopDelete a rank (/rank delete)
rankforge.admin.setopSet a player's rank (/rank set)
rankforge.admin.forceopForce-set a rank bypassing requirements (/rank force)
rankforge.admin.resetopReset a player's rank (/rank reset)
rankforge.admin.bypassreqopInstantly complete a requirement for a player (/rank bypassreq)
rankforge.admin.statsopView system statistics (/rank stats)
rankforge.admin.debugopView rank debug info (/rank debug)
rankforge.admin.securityopView anti-bypass status (/rank security)
rankforge.admin.soundopManage sound settings (/rank sound)
rankforge.admin.xpopSet or add XP for other players (/rank xp set/add)

Wildcard Permissions

PermissionDefaultDescription
rankforge.*opGrants all RankForge permissions
rankforge.use.*trueGrants all player command permissions
rankforge.admin.*opGrants all administrator command permissions

Quest Integration Permission

Quest requirements are gated behind a special permission pattern:

rankforge.quest.completed.<questId>

When a player completes a quest, your quest plugin should grant this permission. RankForge checks it automatically when evaluating the required-quests field.

# Grant a completed quest via LuckPerms
/lp user Steve permission set rankforge.quest.completed.first_quest true

๐Ÿ… Managing Ranks

Creating a Rank

Method 1 โ€” In-game editor (recommended):

/rank create

RankForge will prompt you via chat to type the rank ID. You can also provide the ID directly:

/rank create Builder

The new rank is opened immediately in the RankDetailEditorGUI for further configuration.

Method 2 โ€” Edit ranks.yml directly:

Add a new entry to ranks.yml, then run /rank reload.

Rank IDs must use only letters, numbers, and underscores. The following IDs are reserved and cannot be used: null, none, default, cancel, all, reset, admin.

Editing a Rank

Open the admin GUI:

/rank editor
/rank editor Veteran    โ† edit a specific rank directly

Or edit ranks.yml and run /rank reload.

Deleting a Rank

/rank delete Veteran

RankForge will ask you to confirm by typing yes. This action is irreversible โ€” players whose current rank is deleted will be automatically repaired to the default rank on their next join.

Waiving a Single Requirement

Sometimes a player has earned a requirement through means RankForge can't see directly โ€” a giveaway, a support ticket, or a manual balance adjustment on another system. Rather than force-setting their whole rank, use:

/rank bypassreq Steve money

This marks just the money requirement as satisfied for Steve on his current rank; every other requirement is still checked normally. The bypass is saved to Steve's player data record, so it persists across reloads and reconnects, and is automatically cleared the moment he actually ranks up (or if his data is reset from the Player Data Editor GUI).

Reordering Ranks in the GUI

/rank editor drag

Opens the drag-and-drop slot editor. Click and drag rank icons to change their GUI slot positions. Changes are saved automatically with a debounced write (no save spam).