Englisch

Features
· Synchronize ranks from Minecraft with Discord and/or Teamspeak

· The full code is open-source on GitHub

· The full code is documented for developers

· All messages can be changed

· Works with Bungeecord, Spigot, Waterfall and Paper

· Works with LuckPerms

· No database needed

Requirements
· Bungeecord (or similar e. g. Waterfall) / Spigot (or similar e. g. Paper)

· Teamspeak:

o Serverquery Login

o Group IDs

· Discord:

o Bottoken

o Role IDs

· LuckPerms

· Java 8 or later

Installation
· Download or build the jar.

· Put the jar-File in the “plugins/“ Dictionary of the Server.

· Start and stop the Server.

· The configuration file is generated in “plugins/RankBridge_xxx/“.

· Fill out the “config.yml” file.

Config values

Discord:



enable:

Should the ranks be synchronized with Discord? true/false


token:

Your token for the Discordbot.


activity:

The activity that the bot plays.


guild:

The ID* of the guild where the ranks should used at.


verified_group:

The ID* of the role that verified users get.


groups**:

The permission for a specific role and the role ID*.


* To get the ID for Discord-Support look at this article: https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-

**Please sort the permission on ranks. The most powerful rank at the top and the lowest rank at the bottom.


Teamspeak:



enable:

Should the ranks be synchronized with Teamspeak? true/false


user:

The Serverquery Username


password:

The Serverquery Password


host:

IP-Address of the Teamspeak-Server


port:

The Query-Port of the Teamspeak-Server (Default: 10011)


vserver:

Number of the virtual server (Default: 1)


nickname:

Name of the bot on Teamspeak


verified_group:

The ID of the group that verified users get.


groups*:

The permission for a specific group and the group ID.


* Please sort the permission on ranks. The most powerful rank at the top and the lowest rank at the bottom.


Messages:


discord.verified:
“You were verified with %playername%.“
%uuid% - UUID of the player
%playername% - Name of the player

teamspeak.verify_info:
“Set your Teamspeak name to your Minecraftname and type /verify on the server.“

teamspeak.verified:
“You were verified with %playername%.“
%uuid% - UUID of the player
%playername% - Name of the player

minecraft.verify_info:
“Verfication in progress. Please wait…“

minecraft.verified:
“You were verified with %user%.“
%user% - ID/UUID of the Discord/Teamspeak user.

minecraft.code_info:
“Your verificationcode: %code%“
%code% - Verification code

Please set “:” in ( ‘ ) when you use them.

Planned Features
· Integration with Money-Plugins.

· Your suggestions.

For Developers
· GitHub: https://github.com/Keksnet/RankBridge

· JavaDoc: https://keksnet.github.io/RankBridge/

Please do not use GlobalManager#getInstance() use new RankBridgeAPI() instead.

When you have problems or questions please mention them in a direct message.


Deutsch

Funktionen
· Synchronisiert Minecraft mit Discord und/oder Teamspeak.

· Vollständig Open-Source

· Vollständig dokumentierte Entwickler API

· Alle Nachrichten vollständig konfigurierbar

· Unterstützt Bungeecord, Spigot, Waterfall und Paper

· Unterstützt LuckPerms

· Keine Datenbank benötigt

Voraussetzungen
· Bungeecord (oder ein Fork davon z.B. Waterfall) / Spigot (oder ein Fork davon z.B. Paper)

· Teamspeak:

o Serverquery Login

o Gruppen IDs

· Discord:

o Bottoken

o Rollen IDs

· LuckPerms

· Java 8 oder höher

Installation
· Downloade oder erstelle dir die jar-Datei

· Verschiebe die jar-Datei in den „plugins/“ Ordner des Bungeecords oder des Spigot Servers.

· Starte den Server und stoppe ihn nach dem Start.

· Es erstellt sich nun eine Konfigurationsdatei im Ordner „plugins/RankBridge_xxx/“.

· Öffne die „config.yml“ und fülle sie aus.

Konfigurationsdatei


Discord:


enable:
Sollen die Ränge mit Discord synchronisiert werden? true/false

token:
Der Token für den Discordbot.

activity:
Gibt an was hinter „Spielt “ stehen soll.

guild:
Die Guild ID* auf die synchronisiert werden soll.

verified_group:
Die Rollen ID*, die jeder synchronisierte Nutzer bekommen soll.

groups**:
Die Permission, die für eine spezielle Rolle benötigt wird und die Rollen ID*.

* Um in Discord IDs abzurufen schaut euch diesen Artikel an: https://support.discord.com/hc/de/articles/206346498-Wie-finde-ich-meine-Server-ID-

**Die Permissions müssen nach Rang sortiert werden. Ganz oben muss der höchste Rang stehen, ganz unten der niedrigste.



Teamspeak:


enable:
Sollen die Ränge mit Teamspeak synchronisiert werden? true/false

user:
Der Serverquery Benutzername

password:
Das Serverquery Passwort

host:
Die IP-Adresse des Teamspeak-Servers

port:
Der Query-Port des Teamspeak-Servers (Default: 10011)

vserver:
Nummer des Virtuellen Servers (Default: 1)

nickname:
Name des Bots auf dem Teamspeak

verified_group:
Die Gruppen ID, die jeder synchronisierte Nutzer bekommen soll.

groups*:
Die Permission, die für eine spezielle Rolle benötigt wird und die Rollen ID.

*Die Permissions müssen nach Rang sortiert werden. Ganz oben muss der höchste Rang stehen, ganz unten der niedrigste.



Messages:


discord.verified:
„Du wurdest mit %playername% verifiziert.“
%uuid% - UUID des Spielers
%playername% - Name des Spielers

teamspeak.verify_info:
„Nenne dich im Teamspeak, wie in Minecraft und gebe /verify ein.“



teamspeak.verified:
„Du wurdest mit %playername% verifiziert.“
%uuid% - UUID des Spielers
%playername% - Name des Spielers

minecraft.verify_info:
„Du wirst verifiziert…“

minecraft.verified:
„Du wurdest mit %user% verifiziert.“
%user% - ID/UUID des Discord/Teamspeak Nutzers.

minecraft.code_info:
„Dein Verifizierungscode lautet: %code%“
%code% - Verifizierungscode

Wenn du „:“ benutzt schreibe es in einfache Anführungszeichen ( ‘ ).

Geplante Features
· Integrationen mit Money-Plugins.

· Vorschläge werden gerne gesehen.

Für Entwickler
· GitHub: https://github.com/Keksnet/RankBridge

· JavaDoc: https://keksnet.github.io/RankBridge/

Bitte nutzt nicht direkt GlobalManager sondern erstellt eine neue Instanz von RankBridgeAPI.

Fragen/Probleme könnt ihr per Direktnachricht melden.