Ranks

MuteCloud ships its own simple permission system for players. Ranks have a prefix, a suffix, a priority and permissions; players receive ranks and, where needed, individual permissions on top. The bridge applies this on every server and on the proxy, without any further plugin. If you already use LuckPerms, you do not need it and leave ranks.toml empty.

Not to be confused with access.toml: that file controls who may operate the cloud itself, see Security.

An example

rank create vip 10
rank prefix vip &6VIP &7
rank grant vip essentials.fly
rank create team 50
rank inherit team vip
rank prefix team &cTeam &7
rank grant team mutecloud.maintenance.bypass
rank give MuteBefehl team
rank user MuteBefehl

Every player implicitly holds the rank default, which the cloud creates on first start and which cannot be deleted. A new rank inherits default automatically.

Commands

Command	Effect
`rank`	all ranks by priority
`rank info <rank>`	fields of a rank
`rank create <name> [priority]`	new rank, priority 0 if omitted
`rank delete <rank>`	also removes it from players and from inheritance
`rank prefix <rank> <text>`, `rank suffix <rank> <text>`	text with spaces and `&` colours
`rank priority <rank> <number>`	ordering
`rank inherit <rank> <parent>`	inherits the permissions of another rank, a second call removes it
`rank grant <rank> <permission>`, `rank revoke <rank> <permission>`	give or take a permission, `-permission` denies
`rank give <player> <rank>`, `rank take <player> <rank>`	assign or remove a rank
`rank allow <player> <permission>`	individual permission for one player
`rank deny <player> <permission>`	individual denial, overrides the rank
`rank clear <player> <permission>`	removes the individual entry again
`rank user <player>`	ranks, display and effective permissions of a player
`rank check <player> <permission>`	yes or no

Every change is saved immediately and distributed to the affected players, even while they are online. Only players who have joined the network at least once can receive a rank.

How permissions are evaluated

The permissions of all of a player's ranks, including inherited ones, are chained in ascending order of priority, followed by the player's individual permissions. The last matching entry decides. A rank with higher priority therefore wins over a lower one, and an individual permission wins over all ranks.

* matches every permission, essentials.* matches essentials itself and everything below it. A leading - denies. Case does not matter.

Prefix and suffix come from the directly assigned rank with the highest priority; inherited ranks do not count for this. On the servers they appear in the tab list before and after the name, in chat only with [chat] enabled in network.toml. On servers up to 1.20.4 Minecraft truncates the name in the tab list to 16 characters.

With LuckPerms

On the proxy the bridge asks MuteCloud first. If an entry there has something to say about the requested permission, it applies; otherwise the existing permission plugin answers. On the servers both set their permissions independently of each other. It is cleaner to decide on one.

The file

ranks.toml

[ranks.vip]
prefix = "&6VIP &7"
suffix = ""
priority = 10
inherits = ["default"]
grants = ["essentials.fly"]
 
[players.mutebefehl]
name = "MuteBefehl"
uuid = "..."
ranks = ["team"]
grants = []

ranks.toml is read only when the cloud starts, and the cloud rewrites it on every player join. Edit it by hand only while the cloud is stopped, otherwise your changes are lost. While running, the rank commands are the right way.