diff --git a/README.md b/README.md index 670f856..054819e 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,196 @@ - # NexusLobby -**Version:** 1.0.0 -**Minecraft:** 1.21 (Spigot / Paper) -**Author:** M_Viper +Ein umfassendes Lobby-Plugin fur Minecraft Server (Paper/Spigot 1.21+) mit modularem Aufbau, umfangreichen Sicherheitsfunktionen und voller Konfigurierbarkeit. -NexusLobby ist ein **modulares, professionelles Lobby-Plugin** für moderne Minecraft-Netzwerke. -Der Fokus liegt auf Erweiterbarkeit, sauberer Struktur und vollständiger Konfigurierbarkeit. +![Minecraft](https://img.shields.io/badge/Minecraft-1.21+-green) +![Java](https://img.shields.io/badge/Java-21+-orange) +![License](https://img.shields.io/badge/License-Proprietary-red) + +--- + +## Lizenz und Nutzungsbedingungen + +**ALLE RECHTE VORBEHALTEN** + +Dieses Plugin ist urheberrechtlich geschutzt. Es gelten folgende Bedingungen: + +- Die Nutzung ist ausschliesslich fur den personlichen Gebrauch gestattet +- Die Weitergabe, Verbreitung oder Veroffentlichung des Plugins ist **strengstens untersagt** +- Jegliche Anderung, Modifikation oder Dekompilierung des Codes ist **verboten** +- Das Plugin darf nicht verkauft, vermietet oder anderweitig kommerziell genutzt werden +- Eine Weitergabe an Dritte ist ohne ausdruckliche schriftliche Genehmigung nicht gestattet + +Bei Verstoss gegen diese Bedingungen behalten wir uns rechtliche Schritte vor. + +--- ## Features -- Modulares System (einzeln aktivierbare Module) -- Lobby-Schutzsystem (Spawn Protection, Build-Modus) -- Portal-System (Server & Welt-Portale) -- Wartungsmodus -- ActionBar Animationen -- Modernes Scoreboard -- ServerSwitcher GUI -- ArmorStand Tools (GUI & Command Binder) -- Vollständig permissionsbasiert -- LuckPerms / PlaceholderAPI / Vault / WorldGuard Support +### Lobby-Management +- **Spawn-System** - Automatischer Teleport zum Spawn bei Join/Respawn +- **Void-Schutz** - Automatischer Teleport bei Fall ins Void +- **Doppelsprung** - Konfigurierbarer Double-Jump mit Cooldown +- **Build-Modus** - Schnelles Umschalten zwischen Bau- und Spielmodus -## Voraussetzungen +### Visuelle Elemente +- **Scoreboard** - Anpassbares Sidebar-Scoreboard mit Animationen +- **Tablist** - Header und Footer mit PlaceholderAPI-Support +- **BossBar** - Animierte Boss-Bar mit wechselnden Nachrichten +- **ActionBar** - Permanente ActionBar-Nachrichten -- Java 17+ -- Paper / Spigot 1.21+ -- (Optional) LuckPerms -- (Optional) PlaceholderAPI -- (Optional) Vault -- (Optional) WorldGuard +### Sicherheit +- **VPN-Blocker** - Blockiert VPN/Proxy-Verbindungen (proxycheck.io API) +- **Country-Blocker** - Erlaubt nur bestimmte Lander (Whitelist/Blacklist) +- **Wartungsmodus** - Sperrt den Server fur nicht-berechtigte Spieler +- **Lobby-Schutz** - Verhindert Griefing und unerwunschte Aktionen + +### Zusatzliche Module +- **Portal-System** - Erstelle Portale fur Server-Wechsel (BungeeCord) +- **ArmorStand-Tools** - Bearbeite ArmorStands mit GUI und Command-Binding +- **Server-Switcher** - GUI-basierter Server-Wechsel +- **Spieler verstecken** - Toggle fur Spieler-Sichtbarkeit +- **Chat-Suppressor** - Unterdruckung fur globalen Chat + +--- ## Installation -1. Server stoppen -2. `NexusLobby.jar` in den `plugins/` Ordner legen -3. Server starten -4. Konfiguration anpassen -5. `/nexuslobby reload` +### Voraussetzungen +- Paper/Spigot Server 1.21 oder hoher +- Java 21 oder hoher -## Befehle (Auszug) +### Optionale Abhangigkeiten +- [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) - Fur Platzhalter-Support +- [LuckPerms](https://luckperms.net/) - Fur Berechtigungsverwaltung -| Befehl | Beschreibung | Permission | -|------|-------------|------------| -| /portal | Portalverwaltung | nexuslobby.portal | -| /giveportalwand | Portal-Werkzeug | nexuslobby.portal.give | -| /maintenance on/off | Wartungsmodus | nexuslobby.maintenance | -| /serverswitcher | Server GUI | nexuslobby.serverswitcher | -| /settings | Lobby-Einstellungen | nexuslobby.admin | -| /build | Baumodus | nexuslobby.build | -| /nexuslobby reload | Plugin Reload | nexuslobby.admin | +### Schritte +1. Lade `NexusLobby-1.0.0.jar` herunter +2. Kopiere die JAR in den `plugins/` Ordner deines Servers +3. Starte den Server neu +4. Konfiguriere das Plugin in `plugins/NexusLobby/` -## Wiki +--- -➡ **Die vollständige Dokumentation befindet sich im Wiki-Ordner** +## Befehle + +| Befehl | Beschreibung | Berechtigung | +|--------|--------------|--------------| +| `/nexuslobby` | Hauptbefehl mit Hilfe | `nexuslobby.use` | +| `/nexuslobby reload` | Konfiguration neu laden | `nexuslobby.reload` | +| `/nexuslobby setspawn` | Spawn-Punkt setzen | `nexuslobby.setspawn` | +| `/build` | Build-Modus umschalten | `nexuslobby.build` | +| `/maintenance` | Wartungsmodus verwalten | `nexuslobby.maintenance` | +| `/portal` | Portal-System verwalten | `nexuslobby.portal` | +| `/armorstand` | ArmorStand-Editor | `nexuslobby.armorstand` | +| `/lobbysettings` | Spieler-Einstellungen | `nexuslobby.settings` | + +--- + +## Konfiguration + +### config.yml +```yaml +prefix: "&8[&6NexusLobby&8] " + +spawn: + teleport_on_join: true + teleport_on_respawn: true + world: "world" + x: 0.5 + y: 100.0 + z: 0.5 + +double_jump: + enabled: true + cooldown: 3 + velocity_y: 1.0 + velocity_multiplier: 1.5 +``` + +### settings.yml +```yaml +player_visibility: true +double_jump: true +flight: false + +gamerules: + block_break: false + block_place: false + pvp: false + hunger: false + fall_damage: false +``` + +### visuals.yml +```yaml +scoreboard: + enabled: true + title: "&6&lNEXUS LOBBY" + lines: + - "&7" + - "&fSpieler: &a%online%" + - "&fRang: &e%luckperms_primary_group_name%" + +tablist: + enabled: true + header: + - "&6&lNEXUS NETWORK" + footer: + - "&7Spieler online: &a%online%" + +bossbar: + enabled: true + messages: + - "&6Willkommen auf NexusNetwork!" +``` + +--- + +## Berechtigungen + +| Berechtigung | Beschreibung | +|--------------|--------------| +| `nexuslobby.*` | Alle Berechtigungen | +| `nexuslobby.use` | Grundlegende Nutzung | +| `nexuslobby.reload` | Konfiguration neu laden | +| `nexuslobby.setspawn` | Spawn setzen | +| `nexuslobby.build` | Build-Modus nutzen | +| `nexuslobby.maintenance` | Wartungsmodus verwalten | +| `nexuslobby.portal` | Portale verwalten | +| `nexuslobby.armorstand` | ArmorStand-Editor nutzen | + +### Bypass-Berechtigungen + +| Berechtigung | Beschreibung | +|--------------|--------------| +| `nexuslobby.bypass.protection` | Lobby-Schutz umgehen | +| `nexuslobby.bypass.maintenance` | Wartungsmodus umgehen | +| `nexuslobby.bypass.vpn` | VPN-Blocker umgehen | +| `nexuslobby.bypass.country` | Country-Blocker umgehen | + +--- + +## PlaceholderAPI + +Das Plugin registriert eigene Platzhalter unter der Expansion `nexuslobby`: + +| Platzhalter | Beschreibung | +|-------------|--------------| +| `%nexuslobby_online%` | Spieler online | +| `%nexuslobby_max_players%` | Maximale Spieler | +| `%nexuslobby_maintenance%` | Wartungsmodus Status | +| `%nexuslobby_build_mode%` | Build-Modus Status | +| `%nexuslobby_double_jump%` | Double-Jump Status | + +--- + +## Support + +- [Wiki](../../wiki) - Ausfuhrliche Dokumentation +- [Issues](../../issues) - Bug-Reports und Feature-Requests + +--- + +**Copyright (c) 2024 - Alle Rechte vorbehalten** + +Die unbefugte Vervielfaltigung, Verbreitung oder Weitergabe dieses Plugins ist strafbar und wird rechtlich verfolgt.