Vanish Module

The Vanish Module allows staff members to become invisible to players, with comprehensive configuration options for complete stealth mode.

🚀 Features

Core Functionality

Complete Invisibility - Hide from other players completely
Tab List Hiding - Remove from tab completion
Player List Hiding - Not visible in /list
Name Tag Hiding - Hide floating name tags
God Mode - Automatic damage immunity
Flight - Enable flying while vanished

Advanced Features

Item Pickup Prevention - Can’t pick up items while vanished
Block Interaction Prevention - Can’t interact with blocks
Block Breaking Prevention - Can’t break blocks while vanished
Damage Prevention - Can’t take damage
Mob Targeting Prevention - Mobs won’t target you
Damage Dealing Prevention - Can’t damage others
Action Bar Display - Visual indicator when vanished

📋 Commands

`/vanish`

Toggle vanish on or off.

Permission: zenith.vanish

Usage:

/vanish        # Toggle vanish for yourself

`/vanish <player>`

Toggle vanish for another player.

Permission: zenith.vanish.others

Parameters:

player - Player name to toggle vanish

Examples:

/vanish Player123

🔔 Notifications

Join Notifications

When a vanished player joins or leaves, staff with appropriate permissions will receive notifications.

Configuration

vanish:
  notifications:
    enabled: true
    vanished_message: "{prefix}&#00FF00{player} &#7F7F7Fis now vanished"
    unvanished_message: "{prefix}&#FF0000{player} &#7F7F7Fis no longer vanished"

Permissions

zenith.vanish.notify - Receive vanish notifications

Disable Notifications

To disable vanish notifications:

vanish:
  notifications:
    enabled: false

⚙️ Configuration

Module Settings

enabled: true

vanish:
  messages:
    enabled: "{prefix}&#00FF00You are now vanished!"
    disabled: "{prefix}&#FF0000You are no longer vanished!"

  effects:
    hide_from_tab: true
    hide_from_list: true
    make_invisible: true
    hide_name_tag: true
    prevent_item_pickup: true
    prevent_block_interaction: true
    prevent_block_breaking: true
    auto_god_mode: true
    prevent_damage: true
    prevent_mob_targeting: true
    prevent_dealing_damage: true
    allow_flying: true
    flying_speed: 0.1

Action Bar Configuration

actionbar:
  enabled: true
  vanished_message: "{prefix}&#00FF00%smcaps%VANISH: ON%smreset%"
  not_vanished_message: "{prefix}&#FF0000%smcaps%VANISH: OFF%smreset%"
  not_vanished_duration: 60

🔐 Permissions

Required Permissions

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

permissions:
  - zenith.vanish: true
  - zenith.vanish.others: true
  - zenith.vanish.see: true

What they can do:

✅ Vanish themselves
✅ Vanish other players
✅ See other vanished players
✅ Receive notifications

permissions:
  - zenith.vanish: true

What they can do:

✅ Vanish themselves
❌ Vanish other players
❌ See other vanished players
❌ Receive notifications

🎨 Vanish Effects

Complete Invisibility

When vanished, players are completely invisible to others:

Not visible in player list
Not visible in tab list
Name tags are hidden
Can’t be targeted by mobs
Can’t be damaged

Interaction Restrictions

Vanished players have restricted interactions:

Item Pickup - Prevented (prevents unwanted item collection)
Block Interaction - Prevented (can’t open chests, doors, etc.)
Block Breaking - Prevented (can’t break blocks)

Auto God Mode

Automatic god mode is enabled:

No damage taken
No mob targeting
Safe investigation mode

Flight Support

Vanished players can fly:

allow_flying: true - Enable flight
flying_speed: 0.1 - Set flight speed (default: 0.1)

📊 Database Schema

Vanish state is stored in the player database:

CREATE TABLE zn_players (
    -- ... other columns ...
    vanished BOOLEAN DEFAULT FALSE,
    -- ... other columns ...
);

🔧 API Integration

Check Vanish Status

boolean isVanished = vanishModule.isVanished(player);

Toggle Vanish

vanishModule.toggleVanish(player);

Apply Vanish Effects

vanishModule.applyVanishEffects(player);

Remove Vanish Effects

vanishModule.removeVanishEffects(player);

🛠️ Troubleshooting

Common Issues

Issue: Player still visible when vanished

Check if make_invisible is enabled
Verify permissions (zenith.vanish)
Check other player’s permissions (zenith.vanish.see)

Issue: Block breaking not prevented

Requires server restart for effect to apply
Check if prevent_block_breaking is enabled

Issue: Can’t see other vanished players

You need zenith.vanish.see permission
Check if other player is actually vanished

Issue: Vanish not working

Check if module is enabled
Verify permissions
Check server logs for errors

Debug Mode

Enable debug mode for detailed logging:

debug:
  enabled: true
  console: true
  file: true

📈 Performance

Optimization Tips

Vanish effects are lightweight
No database queries when toggling vanish
Minimal performance impact
Efficient player hiding using Bukkit API

Monitoring

Track vanish usage
Monitor staff activity
Check permission assignments
Review configuration settings

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