diff --git a/README.md b/README.md index a55ad80..16d77f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ -# SuperDevMode +# ServerDevMode -Used for plugin developing and debugging paper spigot servers \ No newline at end of file +**ServerDevMode** is a Minecraft plugin designed to enable a comprehensive server-wide development mode for debugging plugin behavior, chat visibility, and more. It provides live logging, diagnostics, and visibility into plugin interference, with flexible command-based control. + +> ⚡ This plugin is being built **live on Twitch by [Minster586](https://twitch.tv/minster586)**! +> Join the stream to watch development in action, suggest features, or follow along while coding it yourself. + +--- + +## 🧰 Features + +- Enable or disable full development mode with a command +- Select logging level: `minimal`, `verbose`, or `full` +- Automatically logs chat messages, cancelled events, plugin interference, and command activity +- Identifies and logs which plugin cancels a chat message (if applicable) +- Saves logs to timestamped files for historical review +- Packages logs into ZIP archives on demand via command +- Easily extendable for additional event types and plugin monitoring + +--- + +## 💬 Commands + +```bash +/devmode on + Turns on dev mode and starts logging events + +/devmode off + Turns off dev mode and halts logging + +/devmode level [minimal|verbose|full] + Adjusts logging verbosity + +/devmode zip + Compresses recent logs into a timestamped ZIP archive