Configuration Guide

Permissions Configuration

Configure permissions and permission groups for your server

Quick Navigation

Group Permissions

Permission groups for damage formats

Group permissions allow you to assign different damage indicator formats to different player groups. This feature enables you to create visually distinct damage indicators for different ranks or classes on your server.

Group Permission Configuration

config.yml

group-damage-formats:
  default: # Used when no permission matches
    use-simple-formats: true # Set to true to use simple-damage-formats instead
    
  water:
    permission: "vitalstrike.group.water"
    damage-formats:
      default: "<gradient:#1E90FF:#00BFFF>-%.1f 💧</gradient>"
      critical: "<bold><gradient:#0000FF:#000080>-%.1f 🌊</gradient></bold>"
      
  fire:
    permission: "vitalstrike.group.fire"
    damage-formats:
      default: "<gradient:#FF4500:#FF8C00>-%.1f 🔥</gradient>"
      critical: "<bold><gradient:#FF0000:#8B0000>-%.1f ⚔</gradient></bold>"

Group permissions allow you to assign different damage indicator formats to different player groups.

Creating Custom Groups

You can create as many custom groups as you need by adding new entries to the group-damage-formats section. Each group needs a unique identifier, a permission node, and custom damage formats. Players with the corresponding permission will see damage indicators in the specified format.

Example: Water Group

Permission: vitalstrike.group.water

Normal damage: -10.5 💧

Critical damage: -15.0 🌊

Players with the water group permission will see blue-themed damage indicators.

Example: Fire Group

Permission: vitalstrike.group.fire

Normal damage: -10.5 🔥

Critical damage: -15.0 ⚔

Players with the fire group permission will see red/orange-themed damage indicators.

Plugin Permissions

Core permissions for VitalStrike functionality

VitalStrike uses a permission-based system to control access to various features. Some permissions are granted by default to all players, while others are restricted to server operators.

Permission Configuration

plugin.yml

permissions:
  vitalstrike.admin.permissions:
    description: Allows managing VitalStrike permissions
    default: op
  vitalstrike.reload:
    description: Allows reloading the plugin configuration
    default: op
  vitalstrike.give:
    description: Allows giving Vital Awakening items
    default: op
  vitalstrike.use:
    description: Allows using VitalStrike commands
    default: true
  vitalstrike.toggle:
    description: Allows toggling damage indicators
    default: true
  vitalstrike.stats:
    description: Allows viewing combat statistics
    default: true
  vitalstrike.leaderboard:
    description: Allows viewing the leaderboard
    default: true
  vitalstrike.hologram:
    description: Allows toggling combo hologram display
    default: true

Permissions control access to plugin features and commands

Default Permissions

Most basic features like viewing statistics and toggling indicators are enabled by default for all players. Administrative permissions like managing other players' permissions and reloading the plugin are restricted to server operators by default.

Administrative Permissions

vitalstrike.admin.permissionsManage plugin permissions (op)
vitalstrike.reloadReload plugin configuration (op)
vitalstrike.giveGive Vital Awakening items (op)

Player Permissions

vitalstrike.useUse plugin commands
vitalstrike.toggleToggle damage indicators
vitalstrike.statsView combat statistics
vitalstrike.leaderboardAccess leaderboard
vitalstrike.hologramToggle combo holograms

Permission Commands

Commands for managing permissions

VitalStrike provides commands for managing player permissions directly in-game. These commands allow administrators to grant or revoke permissions without editing configuration files.

Permission Command Usage

config.yml

# Permission Commands
/vs perm add <player> <permission> # Add a permission to a player
/vs perm remove <player> <permission> # Remove a permission from a player
/vs perm list <player> # List all permissions for a player

# Examples:
/vs perm add Steve vitalstrike.toggle
/vs perm remove Alex vitalstrike.hologram
/vs perm list Steve

These commands allow administrators to manage player permissions in-game.

Permission Storage

Permissions granted through these commands are stored in the plugin's database file (playerdata.yml). They will persist across server restarts. For more permanent permission management, consider using a dedicated permissions plugin like LuckPerms.

Command Examples

Adding a permission:

/vs perm add Steve vitalstrike.group.fire

This gives Steve the fire group permission, changing their damage indicator format.

Removing a permission:

/vs perm remove Alex vitalstrike.hologram

This removes Alex's ability to toggle combo holograms.

Listing permissions:

/vs perm list Steve

This shows all VitalStrike permissions that Steve currently has.