Skip to content

FTB Ranks and external handlers

FTB Ranks is the recommended provider when a server needs groups, ranks, priorities, or collective administration. Integration is optional and uses the FTB Ranks API at runtime without making it a mandatory dependency.

Install an FTB Ranks version matching the server's Minecraft version and modloader. Do not use a Forge JAR on NeoForge or vice versa.

In AUTO mode, detection priority is:

  1. FTB Ranks installed with a working API;
  2. an active PermissionAPI handler other than the loader's default handler;
  3. the built-in system.

In EXTERNAL, the third step does not exist: without an external provider, permission is denied unless operatorBypass allows the operator.

This selection only applies to restricted kits and protected commands. A public kit does not query FTB Ranks or another external handler.

Backend configuration

To prefer FTB Ranks automatically whenever it is operational:

[permissions]
backend = "AUTO"
operatorBypass = true

Use EXTERNAL when no fallback to permissions.json should be allowed. If FTB Ranks and every other external handler are unavailable, the result is denial.

Rank example

FTB Ranks must receive complete nodes. A conceptual ranks.snbt example for a member group is:

{
  member: {
    name: "Member"
    power: 1
    condition: "always_active"
    permissions: {
      "minecraftserverboostmod.command.kits": true
      "minecraftserverboostmod.command.kit.claim.starter": true
    }
  }
}

The file location and additional fields may vary by FTB Ranks version; preserve the structure generated by the mod. Restart or use the FTB Ranks-documented reload mechanism after editing.

To allow every restricted kit at once, grant:

minecraftserverboostmod.command.kit.claim

Parent node and exceptions

The resolver accepts the specific node or the parent node. If a rank is granted the parent node, setting one specific kit to false in FTB Ranks may not produce the intended exception. Grant only specific nodes when ranks must expose different kits.

Diagnostics

Check the effective provider with:

/msb permission status

FTB Ranks must receive the complete node, including the mod ID. Example:

minecraftserverboostmod.command.kit.claim.starter

If an external provider is active in AUTO, changes made through /msb permission grant remain stored but do not control access until the built-in backend is selected again.

/msb permission grant|deny|unset|list manages permissions.json only; these commands do not modify FTB Ranks ranks or nodes.

For a globally available kit, do not create an everyone rank solely for MSB. Use /kit edit <id> access public. Keep using ranks when access genuinely depends on role, progression, or staff membership.

External loader handler

Minecraft Server Boost queries the global PermissionAPI handler; it neither replaces nor registers a global handler. Global handler configuration remains the responsibility of Forge/NeoForge and the mod providing it.

Kit nodes loaded at startup are registered before PermissionAPI initialization. A kit created while the server is running may require a restart for a handler that depends on registered nodes. FTB Ranks' textual lookup does not depend on that late registration.