Essentials Module

The Essentials Module provides basic administrative tools for player management and server administration.

🚀 Features

Core Functionality

God Mode - Invulnerability toggle
Fly Mode - Flight ability toggle
Heal - Restore player health
Feed - Restore player hunger
Clear - Clear player inventory

Advanced Features

Target Other Players - Apply effects to other players
Staff Notifications - Notify staff of actions
Action History - Track essential actions
Permission-based Access - Granular permission control

📋 Commands

God Mode Commands

`/god [player]`

Toggle God Mode (invulnerability).

Permission: zenith.god

Parameters:

player - Optional: Target player (staff only)

Examples:

/god                    # Toggle your own god mode
/god Player123          # Toggle god mode for Player123

Fly Mode Commands

`/fly [player]`

Toggle Fly Mode (flight ability).

Permission: zenith.fly

Parameters:

player - Optional: Target player (staff only)

Examples:

/fly                    # Toggle your own fly mode
/fly Player123          # Toggle fly mode for Player123

Health Commands

`/heal [player]`

Fully heal a player.

Permission: zenith.heal

Parameters:

player - Optional: Target player (staff only)

Examples:

/heal                   # Heal yourself
/heal Player123         # Heal Player123

`/feed [player]`

Restore a player’s hunger.

Permission: zenith.feed

Parameters:

player - Optional: Target player (staff only)

Examples:

/feed                   # Feed yourself
/feed Player123         # Feed Player123

Inventory Commands

`/clear [player]`

Clear a player’s inventory.

Permission: zenith.clear

Parameters:

player - Optional: Target player (staff only)

Examples:

/clear                  # Clear your own inventory
/clear Player123        # Clear Player123's inventory

⚙️ Configuration

Module Settings

enabled: true

settings:
  god-mode: true
  fly-mode: true
  heal: true
  feed: true
  clear: true
  staff-notifications: true
  target-others: true

Messages

messages:
  staff:
    god_enabled: "&#00FF00God mode enabled!"
    god_disabled: "&#FF5555God mode disabled!"
    fly_enabled: "&#00FF00Fly mode enabled!"
    fly_disabled: "&#FF5555Fly mode disabled!"
    healed: "&#00FF00You have been healed!"
    fed: "&#00FF00You have been fed!"
    cleared: "&#00FF00Your inventory has been cleared!"

  target:
    god_enabled: "&#00FF00God mode enabled for {player}!"
    god_disabled: "&#FF5555God mode disabled for {player}!"
    fly_enabled: "&#00FF00Fly mode enabled for {player}!"
    fly_disabled: "&#FF5555Fly mode disabled for {player}!"
    healed: "&#00FF00{player} has been healed!"
    fed: "&#00FF00{player} has been fed!"
    cleared: "&#00FF00{player}'s inventory has been cleared!"

🔐 Permissions

Required Permissions

Permission	Description
`zenith.god`	Use god mode commands
`zenith.fly`	Use fly mode commands
`zenith.heal`	Use heal commands
`zenith.feed`	Use feed commands
`zenith.clear`	Use clear commands
`zenith.essentials`	All essentials commands

Permission Examples

permissions:
  - zenith.essentials: true

What they can do:

✅ All essentials commands
✅ Target other players
✅ Use all features

permissions:
  - zenith.god: true
  - zenith.fly: true
  - zenith.heal: true
  - zenith.feed: true

What they can do:

✅ God mode, fly mode, heal, feed
✅ Target other players
❌ Clear inventory

permissions:
  - zenith.heal: true
  - zenith.feed: true

What they can do:

✅ Heal and feed players
✅ Target other players
❌ God mode, fly mode, clear

📊 Database Schema

Essentials Table Structure

CREATE TABLE zn_essentials (
    id INT PRIMARY KEY AUTO_INCREMENT,
    player_uuid VARCHAR(36) NOT NULL,
    player_name VARCHAR(16) NOT NULL,
    staff_uuid VARCHAR(36) NOT NULL,
    staff_name VARCHAR(16) NOT NULL,
    action VARCHAR(20) NOT NULL,
    target_player VARCHAR(16),
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

🔧 API Integration

Heal via API

POST /zenith/api/heal
Authorization: Bearer your-token-here

{
  "player": "Player123"
}

Feed via API

POST /zenith/api/feed
Authorization: Bearer your-token-here

{
  "player": "Player123"
}

🎮 Player Experience

What Players Experience

God Mode - No damage from any source
Fly Mode - Can fly and move freely
Heal - Full health restoration
Feed - Full hunger restoration
Clear - Inventory completely emptied

Staff Experience

Success messages - Confirmation of actions
Target feedback - Messages when targeting others
Permission checks - Automatic permission validation
Action logging - All actions are logged

🛠️ Troubleshooting

Common Issues

Issue: Command not working

Check if module is enabled
Verify permissions
Check command syntax
Ensure target player is online

Issue: Permission denied

Check permission configuration
Verify user has correct permissions
Check permission plugin setup
Restart server if needed

Issue: Target player not found

Verify player is online
Check player name spelling
Ensure player is on same server
Check for name changes

Debug Mode

Enable debug mode for detailed logging:

debug:
  enabled: true
  console: true
  file: true

📈 Performance

Optimization Tips

Use MySQL/MariaDB for large servers
Regular database maintenance
Monitor action frequency
Limit concurrent actions

Monitoring

Track command usage
Monitor staff activity
Check permission effectiveness
Review action logs

Need help with the Essentials Module? Join our Discord: https://discord.gg/2qCMn6KHj4