Minecraft-plugin EssentialsDiscord

🔌 Om EssentialsX Discord

EssentialsX Discord (distribueras som modulen EssentialsDiscord) är en officiell EssentialsX-modul som integrerar en Minecraft-server med en Discord-server. Den körs som en plugin jar bredvid EssentialsX:s kärnmodul och ansluter till Discord via en konfigurerad bot token för att vidarebefordra chatt, händelser och ge Discord-side interaktioner som stöds av ett litet API.

🎯 Syfte

Modulens kärnsyfte är dubbelt: att vidarebefordra utvald Minecraft-chatt/händelser till Discord-kanaler och att vidarebefordra utvalda Discord-meddelanden/kommandon till Minecraft-servern. Den är avsedd för serveradministratörer som vill ha direkt, konfigurerbar kommunikation och begränsad fjärrstyrning mellan Discord och en EssentialsX-baserad Minecraft-server.

⚙️ Funktioner

• Konfigurerbar kanal-mappning för olika meddelandetyper (chatt, join/leave, staff, etc.).
• Vidarebefordran av Minecraft-chatt till Discord och valfri vidarebefordran av Discord-meddelanden till Minecraft-chatt.
• slash-kommandon på Discord-sidan som kan köra konsolkommandon, skicka meddelanden till spelare och visa spelarlistor (konfigurerbara och begränsade via roller).
• Finsystem för meddelandetyper och typ-specifik formatering definierad i plugin-konfigurationen.
• Developer API för att registrera anpassade meddelandetyper och Discord-interaktionskommandon via det tillhandahållna DiscordService API:t.

🧩 För vem är den

• Serverägare som kör EssentialsX och vill ha chattsynk mellan Discord ↔ Minecraft.
• Staff-team som vill koppla privata staff-kanaler till staff-medlemmar i spelet.
• Pluginutvecklare som vill exponera enkla Discord-interaktioner eller anpassade meddelandehooks till Discord.

🏗️ Exempel på användning

• Vidarebefordra global chatt till en dedikerad Discord-kanal samtidigt som staff-only Discord-meddelanden skickas till staff i spelet.
• Låta verifierade Discord-roller köra konfigurerade serverfrågor eller kommandon via slash-kommandon utan att exponera dem offentligt.
• Låta ett annat plugin skicka strukturerade notiser till Discord genom att registrera en anpassad meddelandetyp med EssentialsX Discord API:t.

⌨️ Kommandon

EssentialsX Discord erbjuder konfigurerbara slash-kommandon på Discord-sidan (registrerade med Discord) i stället för vanliga Minecraft-chattkommandon. Dessa kommandon (exempel finns i den officiella dokumentationen) körs från Discord och kan exekvera konsolkommandon, skicka meddelanden till spelare eller visa spelarlistor. Kommandotillgänglighet och utökade funktioner styrs av roll/ID-konfiguration i pluginens konfigurationsfil.

🔐 Behörigheter

⚙️ Installation

📥 Setup

• Ladda ner EssentialsX Discord-modulens jar och placera den i serverns plugins/-katalog tillsammans med EssentialsX:s kärn-jar.
• Starta servern för att generera modulens konfiguration och stoppa sedan servern.
• Konfigurera bot token, kanal-ID:n, message-types och rollinställningar för kommandon i plugins/EssentialsDiscord/config.yml enligt dokumentationen och starta sedan om.

📦 Beroenden

• EssentialsX (core) — modulen körs som ett tillägg till EssentialsX-pluginpaketet.

🧠 Tekniska anteckningar

• Modulen tillhandahåller ett service API (DiscordService) så att andra plugin kan registrera anpassade meddelandetyper och skicka meddelanden till konfigurerade Discord-kanaler.
• Discord-side kommandon styrs av roller/ID:n som konfigureras i pluginens konfigurationsfil, i stället för standardiserade Minecraft permission nodes.
• Adminlik konfiguration (bot token, kanal-ID:n, meddelandeformatering, roll-ID:n för kommandon) görs i modulens konfigurationsfil som skapas vid första körningen.

🤝 När detta plugin är användbart

När du behöver hanterad, konfigurerbar tvåvägskommunikation mellan en Discord-community och en EssentialsX-baserad Minecraft-server (inklusive rollbegränsade Discord-kommandon och developer hooks), erbjuder EssentialsX Discord en fokuserad modul som hanterar meddelandemappning och ett litet API för integrationer.