Permissions Guide

This guide explains the permission system in Zenith-Mod and provides examples for different user roles.

🔐 Permission Structure

Zenith-Mod uses a hierarchical permission system that allows for granular control over what users can do.

Base Permissions

Every command requires a base permission to be used:

Permission	Description
`zenith.ban.use`	Required for ban commands
`zenith.mute.use`	Required for mute commands
`zenith.warn.use`	Required for warn commands
`zenith.kick.use`	Required for kick commands
`zenith.freeze.use`	Required for freeze commands
`zenith.essentials.use`	Required for essentials commands
`zenith.notes.use`	Required for notes commands
`zenith.reload`	Required for reload command

Template Permissions

For template-based actions, users need specific template permissions:

Permission	Description
`zenith.ban.template.<template>`	Access to specific ban templates
`zenith.mute.template.<template>`	Access to specific mute templates
`zenith.warn.template.<template>`	Access to specific warn templates

Template-Only Mode

Users with template-only permissions can only use templates, not manual commands:

Permission	Description
`zenith.ban.template.only`	Only template-based bans
`zenith.mute.template.only`	Only template-based mutes
`zenith.warn.template.only`	Only template-based warns

Vanish Permissions

Permission	Description
`zenith.vanish`	Use vanish command on yourself
`zenith.vanish.see`	See vanished players
`zenith.vanish.bypass`	Bypass vanish effects
`zenith.vanish.others`	Vanish other players
`zenith.vanish.notify`	Receive vanish notifications

History Permissions

Permission	Description
`zenith.history`	View player punishment history

Client Detection Permissions

Permission	Description
`zenith.join.client.notify`	Receive client detection notifications
`zenith.join.client.bypass`	Bypass client detection

Check Permissions

Permission	Description
`zenith.check`	Use check command to view alt accounts
`zenith.check.bypass`	Bypass alt account detection

👥 Permission Examples

Full Administrator

A user with full access to all moderation features:

# LuckPerms Configuration
permissions:
  - zenith.ban: true
  - zenith.mute: true
  - zenith.warn: true
  - zenith.kick: true
  - zenith.freeze: true
  - zenith.essentials: true
  - zenith.notes: true
  - zenith.reload: true
  - zenith.ban.notifications: true
  - zenith.mute.notifications: true
  - zenith.warn.notifications: true

What they can do:

✅ Manual bans: /ban <player> <duration> <reason>
✅ Template bans: /ban <player> <template> [reason]
✅ Manual mutes: /mute <player> <duration> <reason>
✅ Template mutes: /mute <player> <template> [reason]
✅ All warn commands
✅ All kick commands
✅ All freeze commands
✅ All essentials commands
✅ All notes commands
✅ Reload configuration

Template-Only Moderator

A user who can only use templates for moderation:

# LuckPerms Configuration
permissions:
  - zenith.ban.use: true
  - zenith.ban.template.only: true
  - zenith.ban.template.spam: true
  - zenith.ban.template.cheating: true
  - zenith.ban.template.griefing: true

  - zenith.mute.use: true
  - zenith.mute.template.only: true
  - zenith.mute.template.spam: true
  - zenith.mute.template.harassment: true

  - zenith.warn.use: true
  - zenith.warn.template.only: true
  - zenith.warn.template.spam: true
  - zenith.warn.template.inappropriate_language: true

  - zenith.kick: true
  - zenith.freeze: true
  - zenith.notes: true
  - zenith.ban.notifications: true
  - zenith.mute.notifications: true

What they can do:

✅ Template bans: /ban <player> <template> [reason]
✅ Template mutes: /mute <player> <template> [reason]
✅ Template warns: /warn <player> <template> [reason]
✅ Kick commands: /kick <player> <reason>
✅ Freeze commands: /freeze <player>, /unfreeze <player>
✅ Notes commands: /notes <player>
❌ Manual bans: /ban <player> <duration> <reason>
❌ Manual mutes: /mute <player> <duration> <reason>

Junior Moderator

A user with limited moderation powers:

# LuckPerms Configuration
permissions:
  - zenith.mute.use: true
  - zenith.mute.template.only: true
  - zenith.mute.template.spam: true

  - zenith.warn.use: true
  - zenith.warn.template.only: true
  - zenith.warn.template.spam: true
  - zenith.warn.template.inappropriate_language: true

  - zenith.kick: true
  - zenith.freeze: true
  - zenith.mute.notifications: true

What they can do:

✅ Template mutes: /mute <player> spam
✅ Template warns: /warn <player> spam
✅ Kick commands: /kick <player> <reason>
✅ Freeze commands: /freeze <player>, /unfreeze <player>
❌ Ban commands
❌ Manual mutes with duration

Helper

A user with minimal powers:

# LuckPerms Configuration
permissions:
  - zenith.freeze: true
  - zenith.notes: true

What they can do:

✅ Freeze commands: /freeze <player>, /unfreeze <player>
✅ Notes commands: /notes <player>
❌ All moderation commands

🛠️ Setting Up Permissions

Using LuckPerms

Install LuckPerms on your server
Create groups for different roles
Assign permissions to groups
Add users to appropriate groups

Example Group Setup:

# Create groups
/lp creategroup admin
/lp creategroup moderator
/lp creategroup helper

# Set up admin group
/lp group admin permission set zenith.ban true
/lp group admin permission set zenith.mute true
/lp group admin permission set zenith.warn true
/lp group admin permission set zenith.kick true
/lp group admin permission set zenith.freeze true
/lp group admin permission set zenith.essentials true
/lp group admin permission set zenith.notes true
/lp group admin permission set zenith.reload true

# Set up template-only moderator group
/lp group moderator permission set zenith.ban.use true
/lp group moderator permission set zenith.ban.template.only true
/lp group moderator permission set zenith.ban.template.spam true
/lp group moderator permission set zenith.ban.template.cheating true
/lp group moderator permission set zenith.mute.use true
/lp group moderator permission set zenith.mute.template.only true
/lp group moderator permission set zenith.mute.template.spam true
/lp group moderator permission set zenith.kick true
/lp group moderator permission set zenith.freeze true
/lp group moderator permission set zenith.notes true

# Set up helper group
/lp group helper permission set zenith.freeze true
/lp group helper permission set zenith.notes true

# Add users to groups
/lp user <username> parent add admin
/lp user <username> parent add moderator
/lp user <username> parent add helper

Using PermissionsEx

groups:
  admin:
    permissions:
      - zenith.ban
      - zenith.mute
      - zenith.warn
      - zenith.kick
      - zenith.freeze
      - zenith.essentials
      - zenith.notes
      - zenith.reload

  moderator:
    permissions:
      - zenith.ban.use
      - zenith.ban.template.only
      - zenith.ban.template.spam
      - zenith.ban.template.cheating
      - zenith.mute.use
      - zenith.mute.template.only
      - zenith.mute.template.spam
      - zenith.kick
      - zenith.freeze
      - zenith.notes

  helper:
    permissions:
      - zenith.freeze
      - zenith.notes

🔒 Security Considerations

Template-Only Mode Benefits

Prevents abuse - Users can’t create custom punishments
Consistency - All punishments follow predefined rules
Escalation - Automatic escalation based on previous offenses
Audit trail - All actions are logged with case IDs

Permission Best Practices

Principle of Least Privilege - Give users only what they need
Regular Audits - Review permissions periodically
Role-based Access - Use groups instead of individual permissions
Documentation - Keep track of what each role can do

📋 Available Templates

Ban Templates

cheating - For cheating/hacking offenses
griefing - For griefing offenses
spam - For spam offenses
harassment - For harassment offenses

Mute Templates

spam - For chat spam
harassment - For harassment
cheating - For cheating-related chat
griefing - For griefing-related chat

Warn Templates

spam - For spam warnings
harassment - For harassment warnings
inappropriate_language - For language warnings
advertising - For advertising warnings
griefing - For griefing warnings
cheating - For cheating warnings

Need help with permissions? Join our Discord: https://discord.gg/2qCMn6KHj4