README.md aktualisiert

2025-08-05 21:18:31 +00:00
parent 56b1168070
commit 6db6869d37
1 changed files with 78 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,79 @@
-# Tel-egram-Chat-Bridge
+# TelegramChatBridge

+## Beschreibung
+TelegramChatBridge ist ein Bukkit/Spigot-Plugin für Minecraft-Server, das den In-Game-Chat mit einer Telegram-Chatgruppe verbindet. Es ermöglicht eine nahtlose Kommunikation zwischen Minecraft-Spielern und Telegram-Nutzern, indem Nachrichten in beide Richtungen gesendet werden können. Das Plugin unterstützt Funktionen wie den Wechsel des Chatmodus, die Verknüpfung von Konten und Benachrichtigungen für Ereignisse (z. B. Spielerbeitritt/-austritt, Tode, Fortschritte, Serverstart/-stopp).
+
+## Funktionen
+- **Bidirektionaler Chat**: Nachrichten von Minecraft nach Telegram und umgekehrt senden.
+- **Chatmodi**: Wechsel zwischen Minecraft- und Telegram-Chatmodus mit den Befehlen `/chat` und `/tg`.
+- **Kontoverknüpfung**: Verknüpfung von Minecraft-Konten mit Telegram-Konten über den Befehl `/link`.
+- **Ereignisbenachrichtigungen**: Konfigurierbare Benachrichtigungen für Spielerbeitritt/-austritt, Tode, Fortschritte, Schlafevents und Serverstart/-stopp.
+- **Anpassbare Nachrichten**: Konfiguration der Nachrichtenformate für Telegram-zu-Minecraft- und Minecraft-zu-Telegram-Kommunikation.
+- **Admin-Befehle**: Verwaltung des Plugins mit dem Befehl `/tb` (reload, info, help).
+- **Berechtigungen**: Unterstützt Berechtigungen für normale Nutzer (`telegramchat.use`) und Admins (`telegramchat.admin`).
+
+## Installation
+1. Lade die neueste Version von `TelegramChatBridge.jar` von der [Releases](https://github.com/deinbenutzername/TelegramChatBridge/releases)-Seite herunter.
+2. Platziere die `.jar`-Datei im `plugins`-Ordner deines Minecraft-Servers.
+3. Starte den Server neu, um die Standardkonfigurationsdatei (`config.yml`) zu generieren.
+4. Bearbeite die `config.yml` mit deinem Telegram-Bot-Token und der Chat-ID.
+5. Starte den Server erneut, um die Konfiguration zu übernehmen.
+
+## Konfiguration
+Die Konfiguration des Plugins befindet sich in der `config.yml`. Hier ist ein Beispiel:
+
+```yaml
+telegram:
+  bot-token: "dein-telegram-bot-token"
+  chat-id: "deine-telegram-chat-id"
+  send-to-telegram: true
+  send-to-chat: true
+  join-and-leave-event: true
+  death-event: true
+  advancement-event: true
+  sleep-event: false
+  server-start-stop: false
+
+messages:
+  telegram-to-minecraft: "&7[&3TG &r-> &2MC&7] &f{username}: &r{message}"
+  minecraft-to-telegram: "[MC -> TG] {username}: {message}"
+  telegram-echo: "&7[&2MC &r-> &3TG&7] &f{username}: &r{message}"
+  mode-set-telegram: "&aDu bist jetzt im Telegram-Chatmodus."
+  mode-set-minecraft: "&aDu bist jetzt im Minecraft-Chatmodus."
+  ```
+
+  - **bot-token**: Dein Telegram-Bot-Token, den du von BotFather erhalten hast.
+  - **chat-id**: Die ID der Telegram-Chatgruppe, die mit Minecraft verbunden werden soll.
+  - **send-to-telegram**: Aktiviert/deaktiviert das Senden von Minecraft-Nachrichten an Telegram.
+  - **send-to-chat**: Aktiviert/deaktiviert das Senden von Telegram-Nachrichten an Minecraft.
+  - **Ereignisschalter**: Aktiviert/deaktiviert Benachrichtigungen für bestimmte In-Game-Ereignisse.
+  - **Nachrichtenformate**: Anpassung der Nachrichten mit Platzhaltern `{username}` und `{message}`.
+
+## Befehle
+  - `/tg`: Wechselt in den Telegram-Chatmodus.
+  - `/chat`: Wechselt in den Minecraft-Chatmodus.
+  - `/link`: Verknüpft dein Minecraft-Konto mit einem Telegram-Konto.
+  - `/tb [reload|info|help]`: Verwaltet das Plugin (einige Unterbefehle nur für Admins).
+
+## Berechtigungen
+  - `telegramchat.use`: Erlaubt die Nutzung der Plugin-Befehle (Standard: true).
+  - `telegramchat.admin`: Erlaubt die Nutzung von Admin-Befehlen wie `/tb reload` (Standard: op).
+
+## Anforderungen
+  - **Minecraft-Server**: Kompatibel mit Spigot/Bukkit-Servern mit API-Version 1.21 oder höher.
+  - **Java**: Java 8 oder höher.
+  - **Telegram-Bot**: Ein Telegram-Bot, erstellt über BotFather, mit einem gültigen Bot-Token.
+  - **Abhängigkeiten**: Keine zusätzlichen Plugins erforderlich.
+
+## Erstellen
+Um das Plugin selbst zu erstellen:
+1. Klone das Repository: `git clone https://github.com/deinbenutzername/TelegramChatBridge.git`
+2. Navigiere in das Projektverzeichnis: `cd TelegramChatBridge`
+3. Erstelle es mit Maven: `mvn clean package`
+4. Finde die kompilierte `.jar`-Datei im `target`-Ordner.
+
+## Lizenz
+Dieses Projekt ist unter der MIT-Lizenz lizenziert. Siehe die [LICENSE](LICENSE)-Datei für Details.
+
+## Support
+Für Probleme, Funktionswünsche oder Fragen öffne bitte ein Issue auf der [GitHub Issues](https://github.com/deinbenutzername/TelegramChatBridge/issues)-Seite.