Let Me Peek

# Let Me Peek A server-side Minecraft mod that lets you observe what your friends and other players are doing through simple commands—without physically moving your player. ## ✨ Features - **Player Observation**: View from any player's perspective without moving yourself - **State Protection**: Automatically saves and restores your position, items, and status effects - **Flexible Switching**: Switch between different observation targets seamlessly - **Privacy Controls**: Private mode, blacklist/whitelist system, and auto-accept settings - **Crash Recovery**: Restores your state even after unexpected server restarts - **Fully Configurable**: All features, limits, and behaviors can be customized via configuration - **LuckPerms Integration**: Complete permission node support for fine-grained access control - **PlaceholderAPI Support**: Rich placeholder system for integration with other mods and plugins ## ⌨️ Commands ### Core Peek Commands ``` /peek player # Start observing a player /peek accept # Accept an incoming peek request /peek deny # Deny an incoming peek request /peek stop # Stop current peek session /peek cancel [player] # Cancel your outgoing request or specific player's /peek who # Show who you're peeking or who's peeking you /peek invite # Send a peek invitation /peek stats [player (ops only)] # View peek statistics /peek debug # Show debug information (ops only) ``` ### Settings Commands ``` /peek settings private # Enable/disable private mode /peek settings auto-accept # Enable/disable auto-accept requests /peek settings blacklist [player] # Manage blacklist /peek settings whitelist [player] # Manage whitelist ``` ### Management Commands ``` /peek manage stats # View global statistics /peek manage top [page] # Show top players by peek count /peek manage list [page] [sort] # List all players with stats /peek manage player # Show detailed player information /peek manage sessions # View all active peek sessions /peek manage force-stop # Force stop a player's session /peek manage cleanup # Perform data cleanup /peek manage reload # Reload configuration /peek manage about # Show mod information ``` ## 🔌 Developer API ### PlaceholdersAPI Integration The mod provides several placeholders for use with other mods or display systems: ``` %peekmod:peek_count% - Number of times the player has peeked others %peekmod:peeked_count% - Number of times the player has been peeked %peekmod:total_duration% - Total time spent peeking (formatted) %peekmod:is_peeking% - Whether player is currently peeking (true/false) %peekmod:is_private% - Whether player has private mode enabled (true/false) ``` ## ⚙️ Configuration Main configuration file: `config/peek/config.yml` (YAML format) ## 🔐 Permission Nodes The mod uses a comprehensive permission system of LuckPerms for fine-grained access control: **📖 For complete permission documentation and LuckPerms examples:** 👉 [View Full Permission Guide](https://github.com/jiazengp/peek/blob/main/PERMISSIONS.md) ## 📝 License [MIT License](./LICENSE)