This commit is contained in:
minster586
2025-06-19 22:00:23 -04:00
parent e455136bcb
commit d43794f34b
30 changed files with 292 additions and 681 deletions

View File

@@ -1,36 +1,23 @@
# SmartCraft Notifier
# SmartCraftNotifier
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.
**SmartCraftNotifier** is a lightweight Spigot plugin that sends real-time join/leave notifications to your [Gotify](https://gotify.net) server. Its clean, customizable, and built with zero external punishment dependencies.
## 🧰 Features
## 🚀 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
- Sends join and leave messages to Gotify
- Uses templates with `{player}` and `{server}` placeholders
- `/scnotify ping` checks if Gotify is online
- `/scnotify status` confirms the configured server name
- Fully configurable `config.yml` and `messages.yml`
- Lightweight: ~2.5MB shaded JAR with OkHttp
## ⚙️ Requirements
## 🛠 Configuration
- 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
### `config.yml`
## 🔧 Build Instructions
```yaml
server-name: SERVER-NAME
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.*
gotify:
url: "https://gotify.example.com"
token: "REPLACE_WITH_YOUR_TOKEN"