diff --git a/README.md b/README.md index 974a424..ec605fd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,115 @@ # ZenithJoin +[![Java](https://img.shields.io/badge/Java-21-orange?style=flat-square)](https://www.oracle.com/java/) +[![Spigot](https://img.shields.io/badge/Spigot-1.21-green?style=flat-square)](https://www.spigotmc.org/) +[![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE) + +

+ Ein modernes Join- & Leave-Plugin für Minecraft-Server +

+ +

+ ZenithJoin Preview +

+ +--- + +## Inhaltsverzeichnis + +- [Funktionen](#funktionen) +- [Installation](#installation) +- [Konfiguration](#konfiguration) +- [Befehle](#befehle) +- [Berechtigungen](#berechtigungen) +- [Support](#support) +- [Credits & Lizenz](#credits--lizenz) + +--- + +## Funktionen + +- ✨ Anpassbare Join- und Leave-Nachrichten +- 🎨 Mehrzeilige Willkommensnachricht mit klickbaren Links +- 🎬 Join-Titel & Untertitel +- ⚡ Action-Bar-Nachrichten +- 🎆 Join-Feuerwerk +- 🌟 Spezial-Events beim ersten Beitritt +- 🔧 Vollständig konfigurierbar (`config.yml`, `messages.yml`) +- 👑 Permissions-basiert +- ✅ PlaceholderAPI & LuckPerms Support + +--- + +## Installation + +1. Lade die neueste **ZenithJoin.jar** aus den Releases herunter +2. Lege die Datei in den Ordner `/plugins` +3. Stelle sicher, dass folgende Abhängigkeiten installiert sind: + - **ProtocolLib** + - **PlaceholderAPI** +4. Starte den Server neu +5. Passe die Konfiguration unter `/plugins/ZenithJoin/` an + +--- + +## Konfiguration + +### `config.yml` +Steuert aktivierte Features, Dauer von Effekten, Feuerwerk-Einstellungen usw. + +### `messages.yml` +Enthält **alle Texte**, die das Plugin ausgibt. + +**Beispiel mit LuckPerms-Prefix:** + +```yaml +PlayerJoinMessage: + Join: "&e{>}&6{>} %luckperms_prefix% &b{player} %luckperms_suffix% &ahat den Server betreten &f &6{<} &e{<}" + ``` + + ## Befehle + +| Befehl | Alias | Beschreibung | Permission | +|------|------|-------------|------------| +| `/zenithjoin` | `/zj` | Plugin-Infos anzeigen | `zenithjoin.info` | +| `/zj help` | – | Befehlsübersicht | `zenithjoin.info` | +| `/zj reload` | – | Konfiguration neu laden | `zenithjoin.reload` | + +--- + +## Berechtigungen + +- `zenithjoin.info` – Plugin-Infos anzeigen +- `zenithjoin.reload` – Konfiguration neu laden +- `zenithjoin.joinmessage` – Join-Nachrichten sehen +- `zenithjoin.leavemessage` – Leave-Nachrichten sehen +- `zenithjoin.welcomemessage` – Willkommensnachricht sehen +- `zenithjoin.title` – Join-Titel sehen +- `zenithjoin.firework` – Join-Feuerwerk sehen +- `zenithjoin.actionbar` – Action-Bar sehen + +--- + +## Support + +Probleme oder Bugs bitte **ausschließlich über GitHub Issues** melden. +Bitte immer folgende Informationen angeben: + +- Server-Version +- Plugin-Version +- Relevanter Log-Auszug + +--- + +## Credits & Lizenz + +**Autor:** M_Viper + +**Verwendete Libraries:** +- Spigot API +- PlaceholderAPI +- ProtocolLib + +Dieses Projekt steht unter der +**GNU General Public License v3.0 (GPL-3.0)**. +