[Bungee/Spigot/Bukkit] Mu1ti1ingu41

    Diese Seite verwendet Cookies. Durch die Nutzung unserer Seite erklären Sie sich damit einverstanden, dass wir Cookies setzen. Weitere Informationen

    • [Bungee/Spigot/Bukkit] Mu1ti1ingu41

      Hallo Community,

      hier möchte ich euch kurz mein kleines Multilanguage Plugin vorstellen.
      Dies ist interessant für Plugin Entwickler welche den Leuten die Sprachauswahl selbst überlassen wollen.

      So können mehrere Sprachen auf einem Server verwendet werden zugleich.

      Das Plugin besteht zum einen aus einem Plugin für den Server selbst, sowohl Bukkit wie auch Spigot. Spigot hat hier den vorteil das Ihr ganz einfach Hover und Click Events mit einfügen könnt.

      Zum Zweiten für BungeeCord. Auch hier sind Hover und Click Events einstellbar direkt bei den Nachrichten.
      Solltet Ihr beide einbinden, läuft der Befehl zum Sprachändern ( Befehl zur Sprachänderung über die Config einstellbar ) über BungeeCord.

      Die BungeeCord version verfügt zusätzlich über die Funktion config Dateien sowie andere yml Dateien von anderen BungeeCords zu öffnen und in dessen eigenen plugin Ordner zu Speichern. Wodurch das Laden und Speichern der Config Datei sowie anderen Dateien ganz leicht fällt und das Plugin BungeeYaml entfällt.


      Verwendung / API:
      Bukkit/Spigot:

      Java-Quellcode

      1. [I]Beispiel Klasse zur verwendung mit Mu1ti1ingu41 und/oder ohne[/I]
      2. [B]Lang.java[/B]
      5. package test.classes;
      7. import test.Test;
      8. import de.bl4ckskull666.mu1ti1ingu41.Language;
      9. import de.bl4ckskull666.mu1ti1ingu41.Mu1ti1ingu41;
      10. import de.bl4ckskull666.mu1ti1ingu41.utils.Utils;
      11. import java.io.File;
      12. import java.io.FileOutputStream;
      13. import java.io.IOException;
      14. import java.io.InputStream;
      15. import java.io.OutputStream;
      16. import java.util.UUID;
      17. import net.md_5.bungee.api.chat.ClickEvent;
      18. import net.md_5.bungee.api.chat.ComponentBuilder;
      19. import net.md_5.bungee.api.chat.HoverEvent;
      20. import net.md_5.bungee.api.chat.TextComponent;
      21. import org.bukkit.Bukkit;
      22. import org.bukkit.ChatColor;
      23. import org.bukkit.command.CommandSender;
      24. import org.bukkit.configuration.file.FileConfiguration;
      25. import org.bukkit.configuration.file.YamlConfiguration;
      26. import org.bukkit.entity.Player;
      28. /**
      29. *
      30. * @author Bl4ckSkull666
      31. */
      32. public final class Lang {
      33. private boolean _isMu1ti1ingu41 = false;
      34. private boolean _isSpigot = false;
      35. private FileConfiguration _fc = null;
      36. public Lang() {
      37. if(Bukkit.getPluginManager().isPluginEnabled("Mu1ti1ingu41")) {
      38. [COLOR="#FF0000"]//ACHTUNG Hier bitte den ordner wo Ihr die languages yaml dateien in eurem Plugin versteckt habt angeben. Bei mir im Ordner [B]languages[/B] ( de.yml, en.yml und lang.yml )[/COLOR]
      39. Mu1ti1ingu41.loadExternalDefaultLanguage(Test.getPlugin(), "languages");
      40. _isMu1ti1ingu41 = true;
      41. } else {
      42. _isSpigot = Bukkit.getVersion().toLowerCase().contains("spigot");
      43. File f = new File(Test.getPlugin().getDataFolder(), "language.yml");
      44. if(!f.exists())
      45. loadLanguageFile();
      46. else
      47. _fc = YamlConfiguration.loadConfiguration(f);
      48. }
      49. }
      51. public void sendMessage(CommandSender cs, String path, String def) {
      52. sendMessage(cs, path, def, new String[] {}, new String[] {});
      53. }
      55. public void sendMessage(CommandSender cs, String path, String def, String[] search, String[] replace) {
      56. if(cs instanceof Player)
      57. sendMessage((Player)cs, path, def, search, replace);
      58. else
      59. cs.sendMessage(getText(UUID.fromString("00000000-0000-0000-0000-000000000000"), path, def, search, replace));
      60. }
      62. public void sendMessage(Player p, String path, String def) {
      63. sendMessage(p, path, def, new String[] {}, new String[] {});
      64. }
      66. public void sendMessage(Player p, String path, String def, String[] search, String[] replace) {
      67. if(_isMu1ti1ingu41) {
      68. Language.sendMessage(CSM.getPlugin(), p, path, def, search, replace);
      69. return;
      70. }
      72. if(!_fc.isString(path) && !_fc.isConfigurationSection(path)) {
      73. p.sendMessage(replaceAll(def, search, replace));
      74. return;
      75. }
      77. if(_isSpigot) {
      78. if(_fc.isConfigurationSection(path) && _fc.isString(path + ".message")) {
      79. TextComponent msg = new TextComponent(replaceAll(_fc.getString(path + ".message"), search, replace));
      80. if(_fc.isString(path + ".hover-msg")) {
      81. msg.setHoverEvent(
      82. new HoverEvent(
      83. Utils.isHoverAction("show_" + _fc.getString(path + ".hover-type", "text"))?HoverEvent.Action.valueOf(("show_" + _fc.getString(path + ".hover-type", "text")).toUpperCase()):HoverEvent.Action.SHOW_TEXT,
      84. new ComponentBuilder(replaceAll(_fc.getString(path + ".hover-msg"), search, replace)).create()
      85. )
      86. );
      87. }
      88. if(_fc.isString(path + ".click-msg")) {
      89. msg.setClickEvent(
      90. new ClickEvent(
      91. Utils.isClickAction(_fc.getString(path + ".click-type", "open_url"))?ClickEvent.Action.valueOf(_fc.getString(path + ".click-type", "open_url").toUpperCase()):ClickEvent.Action.OPEN_URL,
      92. replaceAll(_fc.getString(path + ".click-msg"), search, replace)
      93. )
      94. );
      95. }
      96. p.spigot().sendMessage(msg);
      97. return;
      98. }
      99. }
      100. p.sendMessage(replaceAll(_fc.getString(path), search, replace));
      101. }
      103. public String getText(UUID uuid, String path, String def) {
      104. return getText(uuid, path, def, new String[] {}, new String[] {});
      105. }
      107. public String getText(UUID uuid, String path, String def, String[] search, String[] replace) {
      108. if(_isMu1ti1ingu41)
      109. return Language.getText(CSM.getPlugin(), uuid, path, def, search, replace);
      111. if(!_fc.isString(path) && !_fc.isString(path + ".message"))
      112. return replaceAll(def, search, replace);
      114. if(_fc.isString(path + ".message"))
      115. return replaceAll(_fc.getString(path + ".message"), search, replace);
      116. else
      117. return replaceAll(_fc.getString(path), search, replace);
      118. }
      120. public FileConfiguration getFile(UUID uuid) {
      121. if(_isMu1ti1ingu41)
      122. return Language.getMessageFile(Test.getPlugin(), uuid);
      123. return _fc;
      124. }
      126. private void loadLanguageFile() {
      127. [COLOR="#FF0000"]//ACHTUNG Hier eure Haupt language yaml datei eintragen. Bei mir [B]lang.yml[/B][/COLOR]
      128. InputStream in = Test.getPlugin().getResource("languages/lang.yml");
      129. int c = -1;
      130. File spLang = new File(Test.getPlugin().getDataFolder(), "language.yml");
      131. try {
      132. OutputStream os = new FileOutputStream(spLang);
      133. while((c = in.read()) != -1)
      134. os.write(c);
      135. os.close();
      136. in.close();
      137. _fc = YamlConfiguration.loadConfiguration(spLang);
      138. _fc.save(spLang);
      139. } catch (IOException ex) {
      141. }
      142. }
      144. private String replaceAll(String msg, String[] search, String[] replace) {
      145. if(search.length > 0 && replace.length > 0 && search.length == replace.length) {
      146. for(int i = 0; i < search.length; i++)
      147. msg = msg.replace(search[i], replace[i]);
      148. }
      149. return ChatColor.translateAlternateColorCodes('&', msg);
      150. }
      151. }
      Alles anzeigen


      Quellcode

      1. [B]Bukkit/Spigot Haupt Klasse ( hier Test.java )[/B]
      2. package test;
      4. import org.bukkit.plugin.java.JavaPlugin;
      6. public class Test extends JavaPlugin {
      8. @Override
      9. public void onEnable() {
      10. _plugin = this;
      12. _lang = new Lang();
      13. }
      15. private static Test _plugin = null;
      16. public static Test getPlugin() {
      17. return _plugin;
      18. }
      20. private static Lang _lang = null;
      21. public static Lang getLang() {
      22. return _lang;
      23. }
      24. }
      Alles anzeigen


      Jetzt können wir in unserem Plugin ganz einfach folgende Text Aufrufe verwenden:

      Quellcode

      1. //Direkte Nachricht an Spieler versenden oder auch an CommandSender
      2. Test.getPlugin().getLang().sendMessage(player, "pfad.in.der.lang.datei", "Dies ist ein Standart Text");
      4. //Direkte Nachricht an Spieler versenden oder auch an CommandSender mi Variablen
      5. Test.getPlugin().getLang().sendMessage(player, "pfad.in.der.lang.datei", "Dies %var1% ein %var2% Text %var3%.", new String[] {"%var1%", "%var2%", "%var3%"}. new String[] {"ist", "Standart", "hier"});


      Falls wir mal nur den Text brauchen um z.B. mehrere Text Zeile abzufragen dann könnte man als Beispiel dies so machen:

      Quellcode

      1. int i = 1;
      2. while(!Test.getPlugin().getLang().getText(p.getUniqueId(), "pfad.in.der.yaml.datei." + String.valueOf(i), "--").equalsIgnoreCase("--")) {
      3. Test.getPlugin().getLang().sendMessage(p, "pfad.in.der.yaml.datei." + String.valueOf(i), "Ein Muster Text");
      4. i++;
      5. }




      BungeeCord:
      Hier haben wir ein paar Möglichkeiten mehr durch die Config Datei sowie Custom Dateien.

      Der Beginn:

      Quellcode

      1. package test;
      3. import de.bl4ckskull666.mu1ti1ingu41.Mu1ti1ingu41;
      4. import net.md_5.bungee.api.plugin.Plugin;
      5. import org.bukkit.configuration.file.FileConfiguration;
      7. /**
      8. *
      9. * @author Bl4ckSkull666
      10. */
      11. public class Test extends Plugin {
      12. [B]//Unsere Config Datei[/B]
      13. private FileConfiguration _config;
      14. @Override
      15. public void onEnable() {
      16. _plugin = this;
      18. [B]//Config Datei laden lassen[/B]
      19. loadConfig();
      21. [B]//Die language Dateien aus diesem Plugin laden falls noch nötig - [COLOR="#FF0000"]languages[/COLOR] ist wieder der Ordner wo sich unsere Language Dateien befinden.[/B]
      22. Mu1ti1ingu41.loadExternalDefaultLanguage(this, "languages");
      23. }
      25. public FileConfiguration getConfig() {
      26. return _config;
      27. }
      29. public void loadConfig() {
      30. _config = Mu1ti1ingu41.loadConfig(_plugin);
      31. }
      33. public void saveConfig() {
      34. Mu1ti1ingu41.saveConfig(_config, _plugin);
      35. }
      36. }
      Alles anzeigen


      Da es Unsinn wäre hier eine extra Lang class anzulegen können wir hier unsere Nachrichten direkt über das Plugin senden. Im grossen und ganzen wie beim Bukkit Plugin. Diesmal nur direkt in der Language abgerufen ;-)

      Quellcode

      1. //Direkte Nachricht an Spieler versenden oder auch an CommandSender
      2. Language.sendMessage(Test.getPlugin(), player, "pfad.in.der.lang.datei", "Dies ist ein Standart Text");
      4. //Direkte Nachricht an Spieler versenden oder auch an CommandSender mi Variablen
      5. Language.sendMessage(Test.getPlugin(), player, "pfad.in.der.lang.datei", "Dies %var1% ein %var2% Text %var3%.", new String[] {"%var1%", "%var2%", "%var3%"}. new String[] {"ist", "Standart", "hier"});


      Den reinen Text ggf mit gesetzten Variablen bekommt Ihr so

      Quellcode

      1. int i = 1;
      2. while(!Language.getPlainText(Test.getPlugin(), pp.getUniqueId(), "pfad.in.der.yaml.datei." + String.valueOf(i), "--").equalsIgnoreCase("--")) {
      3. Language.sendMessage(Test.getPlugin(), pp, "pfad.in.der.yaml.datei." + String.valueOf(i), "Ein Muster Text");
      4. i++;
      5. }


      Externe Dateien könnt Ihr Laden/Speichern wie folgt:

      Quellcode

      1. //Lade Custom yml Datei
      2. FileConfiguration fc = Mu1ti1ingu41.loadCustomFile(Test.getPlugin(), "meineDatei.yml");
      4. //Speichern der Datei
      5. Mu1ti1ingu41.saveCustomFile(fc, Test.getPlugin());


      Die Yaml Dateien sind benutzbar wie die Bukkit Yaml Configuration ;-)


      Zur Konfiguration:

      Quellcode

      1. [B][I]Bukkit/Spigot[/I][/B]
      2. #Benutze BungeeCord Sprache?
      3. use-bungeecord: true
      4. #Falls BungeeCord true, ist dieser Teil schon wieder uninteressant.
      5. #Der Begriff welcher zum ändern der Sprache verfügbar ist: Die Sprach Datei ( yml ) zum Begriff.
      6. short-language:
      7. english: en
      8. englisch: en
      9. german: de
      10. deutsch: de
      11. #Verfügbare Sprachen überhaupt
      12. available-languages:
      13. - de
      14. - en
      15. #Sprache die als Standart gesetzt werden soll wenn die eigentliche Sprache nicht verfügbar ist.
      16. default-language: en
      17. #Ersetze Länderkennung mit: verfügbarer Länderkennung.
      18. replace-languages:
      19. at: de
      20. ch: de
      24. [B][I]BungeeCord Konfiguration[/I][/B]
      25. #Der Begriff welcher zum ändern der Sprache verfügbar ist: Die Sprach Datei ( yml ) zum Begriff.
      26. short-language:
      27. english: en
      28. englisch: en
      29. german: de
      30. deutsch: de
      31. #Verfügbare Sprachen überhaupt
      32. available-languages:
      33. - de
      34. - en
      35. #Sprache die als Standart gesetzt werden soll wenn die eigentliche Sprache nicht verfügbar ist.
      36. default-language: en
      37. #Ersetze Länderkennung mit: verfügbarer Länderkennung.
      38. replace-languages:
      39. at: de
      40. ch: de
      41. #Speichere gewählte User sprache?
      42. save-user-language: true
      43. #Unter welchen Befehlen soll das Sprachewechseln verfügbar sein?
      44. commands:
      45. - lang
      46. - language
      47. - sprache
      Alles anzeigen


      Die Permission zum Sprache ändern ist immer "mu1ti1ingu41.change". Ist dies nicht gesetzt, kann die Sprache, welche beim Betreten erkannt wurde über die IP, nicht geändert werden.



      Ich hoffe man versteht die kleine Erklärung zumindest ein klein wenig ;-)
      Bei Fehlern, Fragen oder Anregungen. Einfach bitte hier Posten bzw Fragen.

      Vielen Dank.



      Die Downloads dazu findet Ihr HIER.

      Source Codes:
      Mu1ti1ingu41 für Bukkit/Spigot
      Mu1ti1ingu41 für BungeeCord

    • Werbung zur Unterstützung des Forums ( Bitte AddBlocker deaktivieren )