Internal Groups & Fallbacks

Roster operates on a group-based system. Every player is assigned a group, which dictates their TAB list layout and their Nametag.

groups.yml

By default, Roster defines a few internal groups:

groups:
  default:
    weight: 0
  vip:
    weight: 50
  admin:
    weight: 100

LuckPerms Hook

Roster is designed to be plug-and-play. If you have LuckPerms installed on your server, Roster will automatically hook into it.

When a player joins, Roster will check their primary group in LuckPerms.

• If their primary group in LuckPerms matches a group defined in groups.yml, they will automatically be assigned to that group in Roster.
• Roster will also automatically pull the weight from LuckPerms for sorting purposes.

Standalone Mode

If you don’t use LuckPerms, Roster falls back to its standalone mode. You can manually assign players to internal groups using permissions:

• To make someone a VIP, give them the permission node: roster.group.vip
• To make someone an Admin, give them the permission node: roster.group.admin

If a player has multiple group permissions, Roster will use the one with the highest weight defined in groups.yml.