Files
smartcraft-notifier/README.md
minster586 8016810631 First build
2025-06-19 18:48:53 -04:00

36 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# SmartCraft Notifier
A lightweight Paper plugin that sends player events (join, leave, server switch, and advancements) to a Gotify server via HTTP notifications. Designed for Minecraft 1.19+ networks using BungeeCord or standalone setups.
## 🧰 Features
- Optional BungeeCord integration via Plugin Messaging Channel
- Detects player join/leave and advancement events
- Sends customizable notifications to Gotify servers
- Configurable via `config.yml` (no in-game commands except `/gotifystatus`)
- Console/log alert if Gotify connection fails at startup
## ⚙️ Requirements
- Minecraft Paper server 1.19+
- Java 17+
- [Gotify](https://gotify.net/) server for receiving notifications
- If using BungeeCord, set `bungeecord: true` in `spigot.yml` and enable the flag in the plugin config
## 🔧 Build Instructions
1. Install [Apache Maven](https://maven.apache.org/)
2. Run `build.bat` (Windows) or `mvn clean package` (Linux/macOS)
3. Your compiled plugin will be at `target/SmartCraftNotifier.jar`
## 🚀 Usage
- Drop the plugin into your servers `plugins/` folder
- Edit `config.yml` to set your Gotify server URL, app token, and feature toggles
- Restart your server to generate logs or test with `/gotifystatus`
---
🧠 Inspired by the idea of keeping server owners effortlessly informed.
*Built with care by Erics Copilot.*