Files
sc-ntfy-plugin/README.md
2025-08-09 04:16:29 -04:00

48 lines
1.1 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.

# NTFYNotifier
A lightweight Minecraft plugin that sends real-time alerts to [ntfy.sh](https://ntfy.sh) when players join, leave, or run specific commands. Designed for Paper/Spigot servers on Minecraft 1.14+, this plugin helps admins stay in-the-know wherever they are.
---
## 🔔 Features
- 🔹 Join and Quit Notifications
- 🔹 Command Watcher (customizable)
- 🔹 `%player%`,`%server%` and `%target%` placeholder support
- 🔹 Fully configurable messages and settings
- 🔹 ntfy.sh API integration (with optional basic auth)
---
## 🛠 Installation
1. Place the compiled `NTFYNotifier-1.0.3.jar` in your servers `plugins/` folder.
2. Start the server to generate `config.yml` and `msg.yml`.
3. Customize configuration and messages to your liking.
---
## ⚙ Configuration
### `config.yml`
```yaml
server-name: "NTFYCraft"
ntfy:
server: "https://ntfy.sh"
topic: "minecraft-events"
auth:
enabled: false
username: "user"
password: "pass"
notifications:
join: true
quit: true
commands:
enabled: true
watch:
- "stop"
- "ban"
- "kick"