Skip to main content

LuckPerms Integration

ArenaPvP integrates with LuckPerms for permission management. This integration is optional — if LuckPerms is not installed, ArenaPvP uses the server's default permission system.

How It Works​

When LuckPerms is detected at startup, ArenaPvP automatically uses it for all permission checks. No configuration is needed — the integration is seamless.

The LuckPermsService provides the following capabilities:

MethodDescription
hasPermission(player, permission)Check if a player has a specific permission node
addPermission(player, permission)Grant a permission to a player
removePermission(player, permission)Revoke a permission from a player
getPlayerGroups(player)Get all permission groups a player belongs to
isInGroup(player, group)Check if a player is in a specific permission group
addToGroup(player, group)Add a player to a permission group
removeFromGroup(player, group)Remove a player from a permission group
getPrimaryGroup(player)Get the player's primary group
getPrefix(player)Get the player's prefix (for display)

Setup​

  1. Install LuckPerms on your Hytale server.
  2. Start the server — ArenaPvP detects LuckPerms automatically.
  3. You'll see this log message on startup:
    LuckPerms integration initialized successfully

If LuckPerms is not found, you'll see:

LuckPerms not available (optional): ...

This is normal — ArenaPvP will fall back to the default permission provider.

Permission Nodes​

See the Permissions Reference for all ArenaPvP permission nodes. All of them work with LuckPerms out of the box.

Arena Permission Groups​

The DisableGroupPermission config setting works with LuckPerms groups. When you list group names in this setting, players will be temporarily removed from those LuckPerms groups while inside an arena:

{
"DisableGroupPermission": ["fly-users", "creative-mode"]
}

This ensures abilities tied to those groups (like flying) are disabled during matches. Players are automatically restored to their groups when the match ends.