Peek - Magical Spectator Plugin ✨

A magical Minecraft plugin that allows players to view other players' perspectives through spectator mode.

🌟 Magical Features

• 🎯 Spectator Mode Peeking
• 🔮 Privacy Mode & Request System
• ⏳ Magic Cooldown
• 📊 Detailed Usage Statistics
• 🌍 Cross-Dimension Teleportation
• 🎵 Custom Sound Effects
• 💫 State Save & Restore
• 📈 PlaceholderAPI Support

📌 Important Notes

1. Requires Paper/Folia server
2. Supports Minecraft 1.20+
3. PlaceholderAPI recommended
4. Privacy mode requires players to be online
5. Cross-dimension teleportation may be affected by server settings
6. Statistics are auto-saved periodically
7. Cooldown times are configurable
8. All messages are customizable
9. All sound effects are customizable
10. Statistics variables require PlaceholderAPI

🎮 Quick Start

1. Download the latest version of Peek
2. Place it in your server's plugins folder
3. Restart the server
4. (Optional) Install PlaceholderAPI for advanced variables

📜 Commands

• /peek <player> - Start peeking at a player
• /peek exit - Stop peeking
• /peek stats - View statistics
• /peek privacy - Toggle privacy mode
• /peek accept - Accept peek request
• /peek deny - Deny peek request

🔑 Permissions

• peek.use - Allow using basic peek feature
• peek.bypass - Allow bypassing privacy mode
• peek.nocooldown - Allow bypassing cooldown
• peek.stats - Allow viewing statistics

⚙️ Configuration

Basic Settings

Debug mode
debug: false
Limit settings
limits:
max-peek-distance: 50.0 # Maximum peek distance
cooldown:
enabled: true # Enable cooldown
duration: 90 # Cooldown duration (seconds)
Privacy settings
privacy:
request-timeout: 30 # Request timeout (seconds)
cooldown:
enabled: true # Enable request cooldown
duration: 90 # Cooldown duration (seconds)
Sound settings
sounds:
start-peek: ENTITY_ENDERMAN_TELEPORT # Start peek sound
end-peek: ENTITY_ENDERMAN_TELEPORT # End peek sound

📊 PlaceholderAPI Variables

• %peek_peek_count% - Number of times player used peek
• %peek_peeked_count% - Number of times player was peeked
• %peek_total_duration% - Total peek duration (minutes)
• %peek_is_peeking% - Whether player is currently peeking
• %peek_is_private% - Whether player has privacy mode enabled

🎯 Feature Details

1. Spectator Mode

   • Automatic switch to spectator mode
   • Automatic target following
   • Auto-end when out of range

2. Privacy Mode

   • Requires request when enabled
   • Auto-cancel on timeout
   • Configurable request cooldown

3. State Preservation

   • Automatic state saving
   • Auto-restore after disconnection
   • Cross-server restart support

4. Distance Limits

   • Configurable maximum peek distance
   • Auto-end when exceeded
   • Cross-dimension teleportation

🎯 Technical Features

1. Folia Support

   • Full Folia multi-threading support
   • Optimized region scheduler usage
   • Safe cross-thread operations

2. State Management

   • Automatic player state saving
   • Safe state restoration mechanism
   • Cross-server restart protection

3. Performance Optimization

   • Asynchronous data processing
   • Optimized memory management
   • Automatic cleanup system

🛠️ Development Requirements

• Java 21+
• Paper/Folia 1.20+
• PlaceholderAPI (Optional)

📦 Build Tools

• Maven
• Adventure API
• Folia API
• PlaceholderAPI

🔄 Changelog

v2.7

• ✨ Improved Folia support
• 🔒 Enhanced state saving mechanism
• 🎯 Optimized distance check logic
• 🎵 Added more sound options

🐛 Issue Reporting

If you encounter any issues while using this plugin, please report them:

1. Create an issue on GitHub Issues

📄 License

This project is licensed under the MIT license.

🙏 Acknowledgments

• Paper - High performance Minecraft server
• Folia - Multi-threaded server
• MiniMessage - Text formatting library