Language System

Das Sprach System des Plugins

Wie benutzt man das System

In der Config ist eine Option die heißt "language" und dort kann man die Sprache einstellen! Dann gibt es den "languages" Ordner in den kommen alle Sprachen rein die du haben willst. (Sprache Hinzufügen) Wenn du dann ein paar Sprachen drin hast kannst du in der Config die Option auf den Namen der Sprach Datei stellen. Also wenn die Datei "Example.yml" heißt, musst du die Option auf "Example" stellen da die Datei so heißt. Und dann nur noch die Sprach-Dateien und Configs über den Knopf im Start Menü reloaden!

Custom Optionen und Language File Updater

Die Custom Optionen sind momentan nur für Items vorhanden. Folgende sind vorhanden:

• slot: <Slot> | Diese Option erlaubt es bei Items die Position im Menü zu ändern

• enchanted: <true|false> | Diese Option ermöglicht es die Items enchanted aussehen zu lassen im Menü

• disabled: <true|false> | Diese Option deaktiviert die Items bei denen sie steht

Der Language File Updater ist ein System, was die Files wie es der Name sagt automatisch updated: Heißt man muss nicht mehr selber die ganzen Optionen und Kommentare übertragen oder gar die ganze Config löschen. Außerdem setzt er Optionen wieder in die Config ein, wenn sie fehlen. Und löscht alte, die nicht mehr benötigt werden (Vielleicht wird das wieder entfernt).

Benutzerdefinierte Sprachen

Als erstes brauchst du eine Sprach Datei, die kann man wenn vorhanden hier sich runterladen! Dann muss man diese Sprachdatei in den "languages" Ordner verschieben (im Plugin Folder wo auch die "config.yml" drin ist) Und die Sprache in der Config auf den Namen der Datei (ohne ".yml") ändern! Fertig

Sprachen einreichen

• Man kann wenn man sich Zeit genommen hat und einen existierend Sprachdatei umgeändert oder die Datei erstellt hat diese Sprache auf Discord in den admin-panel-languages Channel hochladen für andere Leute! Und dann können andere Leute diese Sprache auch benutzen! Aber das andere die Sprache nutzen können musst du sie hochladen oder verschicken!

• Falls du aber möchtest das deine Sprache als Standard Sprache in das Admin-Panel kommt muss du mich privat auf Spigot oder Discord anschreiben und mir die Sprache schicken die ich adden soll!

Placeholder System

• Man kann jetzt per Code Placeholder hinzufügen, über das API oder über ein Language Manager Objekt. (Mehr Infos im Developer API Tab)

• Diese Placeholder kann man auch nach Typen sortiert resetten oder auch nur bestimmte aus einer Liste

Language API

• Die Language API von meinem Plugin kann man benutzen wenn man mein Plugin mit Maven oder anders importiert (mit der Developer API dabei)

• Sie hat verschiedene Funktionen und Methoden um das Placeholder System zu steuern, außerdem kann man damit verschiedene Sachen aus den Sprachen auslesen es ist alles eigentlich gut dokumentiert in der Admin Panel API und vielleicht später auch im Language Manager selbst

• Man bekommt ein LanguageManager Objekt indem man die Main Klasse des Admin-Panels ("AdminPanelMain") aufruft und "getPlugin().getLanguageManager()" gibt dann aus der Main Klasse den Admin-Panel Language Manager zurück.

• Wenn man seinen eigenen Language Manager erstellen möchte muss man nur die Sprach Files in dem Ordner hinzufügen in dem auch die plugin.yml oder config.yml liegt. Man muss einen Unterordner "languages" erstellt und dort alle Sprach Files rein tuen.

• Danach muss man nur noch dieses Stück Code in der "onEnable" Methode ausführen:

Code Example

LanguageManager languageManager = new LanguageManager(this, new File(this.getDataFolder() + "/languages"), "<PluginPrefi>");
// Wenn man den Prefix schon vor der Language Manager Init hat,
// dann kann man ihn auch im Contructor eintragen
languageManager.setPrefix("<PluginPrefi>");

// Example Language Files
// "this" ist für die Plugin Main Klasse / Das Plugin
// "de" oder "en" sind die Namen für die Sprache
// Der LanguageFile sucht nach einer Datei die in dem Ordner liegt:
// getDataFolder() + "/languages/<LangName>.yml"
// Wenn sie existiert in der Jar Datei 
LanguageFile deLang = new LanguageFile(this, "de");
LanguageFile enLang = new LanguageFile(this, "en");

// Diese Methode überprüft den im Constructor angegebenen Ordner nach
// Language Files und wenn welche existieren fügt er sie zu einer Liste hinzu
languageManager.addLanguagesToList(true);
// So kann man manuell bestimmte / default Sprachen hinzufügen
languageManager.addLang(deLang, deLang.getLangName());
languageManager.addLang(enLang, enLang.getLangName());

// So setzt man dann als letztes die ausgewählte Sprache
// das erste Argument muss ein Language File sein denn man mit
// languageManager.getLang("<Name>", logInConsole) aus der Liste holen kann
// der Zweite Parameter ist ob es in der Console eine Nachricht ausgeben soll
// Wenn die angegebene Sprache null ist oder nicht existiert,
// wir die erste aus der Liste genommen
languageManager.setCurrentLang(languageManager.getLang(getConfig().getString("Plugin.language"), true), true);

// Und done! Man kann jetzt mit getMessage, getItem, GetMenuTitle, GetCustomObject
// auf die Config zugreifen
// Ein paar Beispiele:
// der erste Parameter steht für den Pfad man muss bei den Nachrichten nicht am Anfang
// Messages. haben bei den Items nicht Items. und bei den Menü Titeln nicht MenuTitle.
// Der zweite Parameter ist der Spieler (kann null sein) der die Nachricht / Item / Menu Title sehen soll
// der dritte Parameter ist ein boolean ob die Placeholder vom Placeholder System die in dieser Nachricht sind 
// zurückgesetzt werden sollen
// so ist es dann auch bei den Items und Menü Titeln
// wenn man zwischen den Spieler und den boolean übrigens noch einen String
// mit einem Language Namen packt kann man die Sprache des Objekts bestimmen
String message = languageManager.getMessage("<Path> zum Beispiel: Plugin.Enable", player, true);