Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/BG-Software-LLC/SuperiorSkyblock2/llms.txt

Use this file to discover all available pages before exploring further.

The roles and permissions system provides fine-grained control over what island members can do. Each role has a weight and a set of default permissions that can be customized per island.

​
Island Roles

SuperiorSkyblock2 includes several built-in roles:

​
Guest Role

Players who are not members of the island:
  • Lowest permission level
  • Cannot perform most actions by default
  • Permissions can be configured per island

​
Coop Role

Players added as cooperators to the island:
  • Temporary members with limited permissions
  • Can build and interact
  • Cannot access admin features
  • Don’t count toward team limit

​
Member Ladder Roles

The member ladder consists of roles with increasing weight: Member (Weight: 0)
  • Default role for new island members
  • Basic building and interaction permissions
  • Can deposit money, access chests, fly
  • Cannot manage other members
Moderator (Weight: 1)
  • Enhanced management permissions
  • Can invite, kick, and ban members
  • Can create and delete warps
  • Can open/close the island
  • Can withdraw money
Admin (Weight: 2)
  • Advanced administrative permissions
  • Can promote and demote members
  • Can manage coops
  • Can set island settings
  • Can change biomes and home location
Leader (Weight: 3)
  • Island owner role
  • All permissions
  • Can transfer leadership
  • Can disband island
Roles are fully customizable in config.yml. You can add unlimited custom roles with any weight and permission set.

​
Viewing Permissions

Check permissions for a specific role: 
/island permissions [player]
This opens a menu showing:
  • All available island permissions
  • Which roles have each permission
  • Current settings for your island
Permissions can be configured globally (for all islands) or per-island. Island-specific settings override global defaults.

​
Managing Member Roles

​
Promoting Members

Increase a member’s role to the next level: 
/island promote <player>
Requirements:
  • superior.island.promote permission
  • PROMOTE_MEMBERS island privilege (Admin role and above)
  • Target must be a member
  • Target must not already be at maximum role

​
Demoting Members

Decrease a member’s role to the previous level: 
/island demote <player>
Requirements:
  • superior.island.demote permission
  • DEMOTE_MEMBERS island privilege (Admin role and above)
  • Target must be a member
  • Target must not already be at minimum role

​
Setting Specific Roles

Set a member to a specific role: 
/island setrole <player> <role>
Requirements:
  • superior.island.setrole permission
  • SET_ROLE island privilege (Admin role and above)
Valid role names:
  • member
  • mod (or moderator)
  • admin
  • Any custom role name defined in config
You cannot set a member to the leader role. Use /island transfer to transfer leadership.

​
Island Permissions

SuperiorSkyblock2 includes extensive permissions for island actions:

​
Building Permissions

  • BUILD - Place blocks
  • BREAK - Break blocks
  • INTERACT - Use doors, buttons, levers
  • CHEST_ACCESS - Open chests and containers

​
Island Management

  • INVITE_MEMBER - Invite players
  • KICK_MEMBER - Remove members
  • BAN_MEMBER - Ban players
  • PROMOTE_MEMBERS - Promote members
  • DEMOTE_MEMBERS - Demote members
  • SET_ROLE - Set member roles

​
Economic Permissions

  • DEPOSIT_MONEY - Deposit to island bank
  • WITHDRAW_MONEY - Withdraw from island bank
  • RANKUP - Purchase upgrades

​
Settings Permissions

  • SET_SETTINGS - Change island settings
  • SET_PERMISSION - Modify permission settings
  • SET_BIOME - Change island biome
  • SET_HOME - Set island home location

​
Warp Permissions

  • SET_WARP - Create warps
  • DELETE_WARP - Remove warps

​
Member Management

  • COOP_MEMBER - Add coop members
  • UNCOOP_MEMBER - Remove coop members
  • EXPEL_PLAYERS - Kick visitors

​
Island Status

  • OPEN_ISLAND - Open to public
  • CLOSE_ISLAND - Close to public
  • CLOSE_BYPASS - Enter when closed
  • EXPEL_BYPASS - Cannot be expelled

​
Special Permissions

  • FLY - Enable island fly mode
  • SPAWNER_BREAK - Break spawners
  • VALUABLE_BREAK - Break valuable blocks
A complete list of all island permissions is available in the wiki documentation.

​
Customizing Permissions

Permissions can be customized at multiple levels:

​
Global Role Defaults

Set in config.yml: 
island-roles:
  ladder:
    member:
      permissions:
        - CHEST_ACCESS
        - DEPOSIT_MONEY
        - FLY

​
Per-Island Settings

Island leaders can customize permissions for their specific island: 
/island permissions
This allows:
  • Granting additional permissions to lower roles
  • Restricting permissions from higher roles
  • Creating unique permission structures
Enable edit-player-permissions in config.yml to allow setting permissions for individual players, not just roles.

​
Role Limits

Limit the number of players that can have specific roles: 
default-values:
  role-limits:
    '1': 5  # Maximum 5 moderators (role id 1)
Benefits:
  • Control island structure
  • Create progression systems
  • Balance team composition

​
Admin Commands

Administrators can manage roles with special commands: 
# Set a player's role
/admin setrole <player> <target> <role>

# Promote a member
/admin promote <player> <target>

# Demote a member
/admin demote <player> <target>

# Set role limit
/admin setrolelimit <player> <role-id> <limit>

# Set global permission requirement
/admin setpermission <permission> <role>

# Reset island permissions to defaults
/admin resetpermissions <player>
Permissions:
  • superior.admin.setrole
  • superior.admin.promote
  • superior.admin.demote
  • superior.admin.setrolelimit
  • superior.admin.setpermission
  • superior.admin.resetpermissions

​
Transferring Leadership

Transfer island ownership to another member: 
/island transfer <player>
Requirements:
  • Must be island owner
  • superior.island.transfer permission
  • Target must be an island member
Effects:
  • Current owner becomes admin
  • Target becomes new leader
  • All permissions transfer
  • Cannot be undone
Transferring leadership is permanent. Make sure you trust the player before transferring ownership.

​
Best Practices

1

Define clear role hierarchy

Ensure each role has distinct responsibilities and permissions.
2

Limit sensitive permissions

Only give withdraw, demote, and management permissions to trusted members.
3

Use role progression

Create a natural progression path from Member → Moderator → Admin.
4

Review permissions regularly

Audit island permissions to ensure they match your needs.

​
Custom Roles

Create custom roles in config.yml: 
island-roles:
  ladder:
    builder:
      id: 10
      name: 'Builder'
      weight: 0
      permissions:
        - BUILD
        - BREAK
        - INTERACT
    trusted:
      id: 11
      name: 'Trusted'
      weight: 1
      permissions:
        - CHEST_ACCESS
        - DEPOSIT_MONEY
Custom role IDs must be unique and should never be changed once set, as they’re used to identify roles in the database.

Build docs developers (and LLMs) love

Get started for freeTalk to us