Skip to content

Commands

Rank commands (/access)

Every /access command to create ranks, grant and revoke them, manage permissions and conditional rules, and migrate from LuckPerms or PermissionsEx.

The ranks module uses one configurable root, /access by default, plus an optional /color shortcut. There are no separate /rank, /grant or /user commands. Subcommands and arguments are always in English.

ranks.ymlYAML
language: en
command: access
aliases: []
color-command: color   # '' disables the standalone command
color-aliases: []

Authority required

OperationRequirement
Define or delete ranks, inheritance and rulesOWNER + sofycore.ranks.manage, or console
Grant, extend and revoke grantsADMIN/OWNER + sofycore.ranks.grant, or console
View other users and rankssofycore.ranks.view (your own data does not need it)
Individual exceptions and other players' colorsOWNER + sofycore.ranks.manage, or console
Grant owner or edit its definitionConsole only

Commands

/access status

Availability (READY, or SUSPENDED while LuckPerms or PermissionsEx is installed), scope GLOBAL/LOCAL_SQLITE and revision.

/access help

Summary of every branch and its main syntax.

/access setup confirm

Installs the optional template: vip, helper, moderator and admin with basic inheritance. Rejected completely if any of those IDs exists.

Also requires
Console, or owner with sofycore.ranks.manage.
access owner <name|uuid>Console only

Grants the permanent owner rank. Only the console can do it; being OP or having * is never enough.

Examples

access owner Steve
access uuid <name>Console only

Shows the UUID this network has registered for a name. Does not create identities.

/access rank list [page]

Lists ranks, ten per page.

Permission
sofycore.ranks.view
/access rank info <rank>

Type, authority, weight, inheritance and appearance of a rank.

Permission
sofycore.ranks.view
/access rank permissions <rank> [page]

Combined permissions, marking direct and inherited/default ones.

Permission
sofycore.ranks.view
/access rank create <id> <NORMAL|DONATOR|STAFF|HIDDEN>

Creates a global rank. IDs: 1–32 lowercase characters starting with a letter.

Permission
sofycore.ranks.manage
Also requires
OWNER authority (or console).

Examples

/access rank create helper STAFF
/access rank set <id> <label|type|authority|weight|prefix|suffix|color> <value...>

Edits a rank: visible label, type, authority (STAFF/ADMIN, STAFF ranks only), weight, prefix, suffix or name color. `clear` empties styles.

Permission
sofycore.ranks.manage
Also requires
OWNER authority (or console).

Examples

/access rank set helper weight 10
/access rank set helper prefix &b[Helper] 
/access rank set vip color &#55aaff
/access rank permission <id> <add|deny|remove> <node...>

Grants, denies or removes one or more permission nodes of a rank. Trailing wildcards such as sofycore.chat.* are accepted.

Permission
sofycore.ranks.manage
Also requires
OWNER authority (or console).

Examples

/access rank permission helper add sofycore.chat.staff sofycore.chat.mute
/access rank inherit <id> <add|remove> <parent>

Adds or removes inheritance. Circular inheritance is rejected.

Permission
sofycore.ranks.manage

Examples

/access rank inherit helper add default
/access rank rule <id> <add|deny|parent|list|remove> ...

Conditional permissions and inheritance with duration and conditions (server, world, gamemode, WorldGuard region/flags). `global` means no condition.

Permission
sofycore.ranks.manage

Examples

/access rank rule vip add essentials.fly permanent world=parcelas
/access rank rule vip add essentials.fly 30m server=survival,world=parcelas
/access rank rule vip add essentials.fly permanent worldguard:region=spawn
/access rank delete <id> confirm

Deletes a rank. Its grants become RANK_DELETED and the ID is retired forever.

Permission
sofycore.ranks.manage
/access user <player> grant <rank> <time|permanent> <reason...>

Adds an independent grant. Rejected if an equal active grant exists (use extend).

Permission
sofycore.ranks.grant
Also requires
ADMIN or OWNER authority, and a strictly lower target rank.

Arguments

  • player (required) — Known player name or UUID.
  • rank (required) — Rank ID.
  • time (required) — Positive integer with s/m/h/d (max 3650 days) or permanent.
  • reason (required) — Free text, up to 256 characters.

Examples

/access user Steve grant vip 30d Purchase
/access user <player> grantat <rank> <time> <conditions> <reason...>

Grants a rank only under certain conditions.

Permission
sofycore.ranks.grant

Examples

/access user Steve grantat vip 30d server=survival,world=parcelas Purchase
/access user <player> revoke <grant-uuid> <reason...>

Removes exactly one grant.

Permission
sofycore.ranks.grant
/access user <player> extend <grant-uuid> <time|permanent> <reason...>

Extends a grant or makes it permanent. Adds from the expiry if still active, or from now if expired.

Permission
sofycore.ranks.grant
/access user <player> <info|grants|permissions> [page]

UUID, authority and revision; grants with IDs, state and expiry; individual exceptions.

Permission
sofycore.ranks.view
/access user <player> permission <add|deny|remove> <node...>

Individual permission exceptions. Applicable individual rules take priority over rank rules.

Permission
sofycore.ranks.manage
/access user <player> check <node>

Explains where a permission comes from. DEFAULT means no explicit rule.

Permission
sofycore.ranks.view
/color [0-f|#rrggbb|reset]

Shows or changes your personal name color. Shortcut of /access color; opens a menu when the menus module is on.

Permission
sofycore.ranks.color
Also requires
Plus sofycore.ranks.color.<0-f> or sofycore.ranks.color.rgb.
access migration luckperms analyze <file> <owner-uuid> <sofycore|import>Console only

Analyzes a LuckPerms 5.x export and creates a plan. Then: report, status, apply <plan> confirm, resume <plan> confirm.

access migration pex analyze <file> <owner-uuid> <sofycore|import>Console only

Analyzes a PermissionsEx permissions.yml from plugins/sofyCore/migrations/pex/ and creates a plan. Then: report, status, apply <plan> confirm, resume <plan> confirm.

Time format

Positive integers with s, m, h or d, up to 3650 days per operation, or permanent. Zero, negative and decimal values are rejected. An extension adds time from the current expiry if still active, or from now if expired.

Conditions

Conditions limit a grant, permission or inheritance to a context. The same type acts as alternatives; different types must all match. Use global for no condition, and ; as an alternative separator when values contain commas.

ConditionExample
Serverserver=survival
Worldworld=world_nether
Game modegamemode=creative
WorldGuard regionworldguard:region=spawn
WorldGuard flagworldguard:flag-pvp=deny
Inside any regionworldguard:in-region=false

Other available contexts are dimension-type, whitelisted and has-played-before.