[Plugin] SprachAPI

noci · Jan 1st 2018

Beschreibung Deutsch

description English

Version:

Hilfe zur Installation:
[Übersetzt] Wie installiert / startet man ein Plugin. / Plug-in installieren
[Tutorial] [HD] [German] Plugins programmieren mit der Rising World Plugin API
Einbindung der Plugin API in IntelliJ IDEA / How to use the Plugin API in IntelliJ IDEA

Beispiel(1.1.3):
In diesem Beispiel zeige ich, welche Unterstützung die API zur Verfügung stellt.

Sprach Daten Erstellen und Laden.
Konfigurations Datei Verwalten und nutzen.
- Die Funktion übernimmt das Datei Management, so wie das Hinzufügen oder entfernen von Schaltern.
- Die Schalter werden Alphabetische sortiert.
Versionen von Plugins Vergleichen/Prüfen.
Versions Fehler Verarbeitung.
Information für Admins, über die benötigte Aktualisierungen.
Variablen Übergabe Klasse für Lambad Funktion.

[Hauptdatei] - Initialisierung und Startoptionen des Plugins

Java: MyPlugin.java

package de.chaoswg.Tutorial;


import de.chaoswg.CRT;
import static de.chaoswg.CRT.isSameVersion;
import de.chaoswg.GetConfigDaten;
import de.chaoswg.SprachAPI;
import net.risingworld.api.Plugin;
import net.risingworld.api.Server;
import net.risingworld.api.World;
import net.risingworld.api.events.EventMethod;
import net.risingworld.api.events.Listener;
import net.risingworld.api.events.player.PlayerCommandEvent;
import net.risingworld.api.objects.Player;




public class MyPlugin extends Plugin implements Listener{
    MyPlugin plugin;
    Server server;
    World world;
    private String conf;
    private int debug;
    int getDebug() { return debug; }
    String requireSprachApiVersion;
    private SprachAPI sprachApiPlugin;
    private GetConfigDaten sysConfig;
    private MyPluginClassText sprachApiDaten;
    @Override
    public void onEnable() {
        plugin                  = this;
        server                  = getServer();
        world                   = getWorld();
        CRT crt                 = new CRT();
        conf                    = crt.getSpecP()+"config";
        debug                   = 1;
        requireSprachApiVersion = "1.1.3";    // Benötigte SprachAPI Version


        // Prüfen ob Sprach API überhaupt installiert ist
        if(plugin.getPluginByName("SprachAPI") != null ){
            // Lade Plugin
            sprachApiPlugin = (SprachAPI) plugin.getPluginByName("SprachAPI");
            // Prüfe SprachAPI Version
            if (isSameVersion(requireSprachApiVersion,sprachApiPlugin.getDescription("version"))){    
                // Lade Eigene Text Klasse
                sprachApiDaten = new MyPluginClassText();
                sprachApiDaten.setDebug(debug);   //### gebe Debug weiter
                sprachApiDaten.setDir(conf+sprachApiDaten.getDir());
                sprachApiDaten.INI(plugin);


                if(debug>0){System.out.println("[" + plugin.getDescription("name") + "] "+"Enabled "+"SprachAPI("+sprachApiPlugin.getDescription("version")+") OK");}
                //#########################
                //### CONFIG für System ###
                //### Definiere Variablen
                String[][] sysConfigArray = {
                    //Name         Wert
                    {"command", "myPl"},
                    {"Debug", String.valueOf(debug)}
                };
                //################################
                //### Initialiesiere System Config
                sysConfig = new GetConfigDaten("System", sysConfigArray, this, debug,conf);
                debug = Integer.parseInt(sysConfig.getValue("Debug"));


                registerEventListener(this);
                //... onEnable stuff
            }else{
                //Sprach API Version zu klein
                System.err.println("[" + plugin.getDescription("name") + "-ERR] Die Version von Plugin 'SprachAPI("+sprachApiPlugin.getDescription("version")+")' ist zu klein! Bitte Aktualisieren auf Version("+requireSprachApiVersion+")!");
                registerEventListener(new MyPluginErrorSprachAPI(this));
            }
        }else{
            //keine Sprach API vorhanden
            System.err.println("[" + plugin.getDescription("name") + "-ERR] Das Plugin 'SprachAPI' ist nicht installiert! Bitte installieren!");
            registerEventListener(new MyPluginErrorSprachAPI(this));
        }
    }


    @Override
    public void onDisable() {
        if(debug>0){System.out.println("[" + plugin.getDescription("name") + "] "+"Disabled ");}
    }
    @EventMethod
    public void onPlayerCommand(PlayerCommandEvent event){
        Player player = event.getPlayer();
        //Command abholen und ggf. Leerzeichen auf eines reduzieren
        String command = event.getCommand();
        String[] cmd = command.split(" ");
        System.out.println("[" + plugin.getDescription("name") + "] "+"onPlayerCommand "+debug);
        if (cmd[0].toLowerCase().equals("/"+sysConfig.getValue("command")) || cmd[0].toLowerCase().equals("/"+sysConfig.getValue("command").toLowerCase())) {
            if (cmd.length > 1){
                //### Zeigt dem Spieler den Eingegebenen Befehl an
                player.sendTextMessage("");
                player.sendTextMessage(("#> "+cmd[0].substring(1)+" "+command.substring(1+cmd[0].length()))); //+1 für jedes Leerzeichen
            }
            if (cmd.length > 1) {
                if (cmd[1].toLowerCase().equals("debug")) {
                    int deb = debug;
                    try{debug=Integer.parseInt(cmd[2]);}catch(NumberFormatException e){
                        System.err.println("[" + plugin.getDescription("name") + "] "+"Fehler "+e.getMessage());
                        debug = deb;
                    }
                }
                if (cmd[1].toLowerCase().equals("msg")) {
                    // Nachricht erstellen, aus den nachfolgenden Komandos
                    String msg = command.substring(cmd[0].length()+1+cmd[1].length()+1); //+1 für jedes Leerzeichen
                    //int n=0; //=> Fehler bei benutzung in der Lambad Function
                    //Abhilfe:
                    CRT.ClassLambadHelper l = new CRT.ClassLambadHelper();
                    l.n = 0;
                    if (msg!=null)
                    server.getAllPlayers().forEach((Player playerBroadcast) -> {
                        if (player!=null){
                            playerBroadcast.sendYellMessage(msg);
                            //n++; //=> Fehler
                            l.n++;
                        }
                    });
                }
            }
        } else if (cmd[0].toLowerCase().equals("/")) {
            // Ausgabe für die Chat Eingabe "/" anzeigen. Das Komando aus der Konfigurations Datei
            player.sendTextMessage("" + "/"+sysConfig.getValue("command"));
        }
    }


}

Display More

[Sprachunterstützung] - Definieren der Sprachen.

Java: MyPluginClassText.java

package de.chaoswg.Tutorial;


import de.chaoswg.SprachAPI;
import java.util.ArrayList;


public class MyPluginClassText extends SprachAPI{
    @Override
    protected void setDatenFunktion(){
        Sprache = new ArrayList();
        Sprache.add("en");
        Sprache.add("de");
        setSprache(Sprache);
        Daten = new String[][] { 
            //Name              en                                                              de
            {"bsp 1"    ,"en Text 1",   "de Text 1"},
            {"bsp 2"    ,"en Text 2",   "de Text 2"}
        };
        setDaten(Daten);        
    }


}

Display More

[Fehler Event] - verarbeitet die Fehler für das Fehlen der API und einer Versionsabhängigkeit.

Java: MyPluginErrorSprachAPI.java

package de.chaoswg.Tutorial;


import net.risingworld.api.Timer;
import net.risingworld.api.events.EventMethod;
import net.risingworld.api.events.Listener;
import net.risingworld.api.events.player.PlayerConnectEvent;
import net.risingworld.api.objects.Player;


public class MyPluginErrorSprachAPI implements Listener {


    private final MyPlugin plugin;
    private final int debug;


    public MyPluginErrorSprachAPI(MyPlugin plugin) {
        this.plugin = plugin;
        this.debug = plugin.getDebug();
    }
    @EventMethod
    public void onPlayerConnectEvent(PlayerConnectEvent event) {
        if(debug>0){System.out.println("[" + plugin.getDescription("name") + "] "+"Connect ");}
        Player player = event.getPlayer();
        boolean notFound = (plugin.getPluginByName("SprachAPI") == null);
        if (player.isAdmin()){
            if (player.getLanguage().equals("de")){
                player.sendYellMessage("[" + plugin.getDescription("name") + "]"+"\nPlugin angehalten"+"\n\n"+"\"SprachAPI\" "+(notFound?"nicht gefunden.":"zu Alte Version. "+"\nBenötiege Version("+plugin.requireSprachApiVersion+") "));
            }else{
                player.sendYellMessage("[" + plugin.getDescription("name") + "]"+"\nPlugin stopt"+"\n\n"+"\"SprachAPI\" "+(notFound?"not found.":"to Old Version. "+"\nRequires version("+plugin.requireSprachApiVersion+") "));
            }
            // Das Plugin kann auch, nachdem der erste Admin informiert wurde nach einer gewissen Zeit Komplet abgeschaltet werden.
            // Das Hilft um Konflikte zu Vermeiden.
            // Hier nach 1 Minute und 30 Sekunden.
            Timer closePlugin = new Timer(60f*1.5f, 0f, -1, () -> {  // lambda expression
                // This will be executed when the timer triggers
                plugin.onDisable(); // Plugin Beenden
            });
            closePlugin.start(); // Timer Starten
        }
    }
}

Display More

Für fragen und Anregung von Entwicklern stehe ich auch gerne über die persönlichen Nachrichten zur Verfügung.
For questions and suggestions of developers, I am also happy to personal information available.

Altes Beispiel für (1.0.0)

Display Spoiler

Java: myClass.java

package de.chaoswg;


import net.risingworld.api.Plugin;
import net.risingworld.api.events.EventMethod;
import net.risingworld.api.events.Listener;
import net.risingworld.api.events.player.PlayerCommandEvent;
import net.risingworld.api.events.player.PlayerConnectEvent;
import net.risingworld.api.objects.Player;


public class myClass extends Plugin implements Listener  {
    private mySprachClass textDaten;
    @Override
    public void onEnable() {
        // erstelle deine Class
        // die Werte in der mySpracheClass werden jetzt initialisiert
        //######################## by Google ########################
        // create your class
        // the values in mySpracheClass are now initialized
        textDaten = new mySprachClass();
        textDaten.setDebug(1);
        textDaten.setDir("\config\lang");


        // da die Funktion nicht mit einem zwei Dimensionalen Array arbeitet muss jeztz noch Konvertiert werden ^^
        //######################## by Google ########################
        // since the function does not work with a two dimensional array, it can still be converted ^^
        textDaten.INI(this);
        registerEventListener(this);
    }


    @Override
    public void onDisable() {}
    @EventMethod
    public void onPlayerCommand(PlayerCommandEvent event){
        Player player = event.getPlayer();
        String command = event.getCommand();
        String[] cmd = command.split(" ");
        if (cmd[0].toLowerCase().equals("/mycom") || cmd[0].toLowerCase().equals("/mc")) {
            if (cmd.length == 1) {
                // greife auf den Text deiner Sprach-Class zu
                //######################## by Google ########################
                // access the text of your language class
                player.sendTextMessage(textDaten.getText(player, "command_help"));
            }
            // weiter/go on Command
            //...
        } else if (cmd[0].toLowerCase().equals("/")) {
            player.sendTextMessage("/mycom");
        }
    }
    @EventMethod
    public void onPlayerConnectEvent(PlayerConnectEvent event) {
        Player player = event.getPlayer();
        // benutze den Text, auch für Formatierten Text
        //######################## by Google ########################
        // also use the text for formatted text
        player.sendTextMessage(String.format(textDaten.getText(player, "DafaultWelcomMsg"), getServer().getName()));
    }
}

Display More

Java: mySprachClass.java

package de.chaoswg;


import java.util.ArrayList;


public class mySprachClass extends SprachAPI {
    @Override
    protected void setDatenFunktion(){
        Sprache = new ArrayList();
        // definiere deine Sprachen, in dem du die Länderkennung der ArrayListe hinzufügst.
        // wobei die erste Sprache die Standard Sprache ist. z.B. Spielersprache nicht berücksichtigt, Server erstellt neue Speilersprache
        //######################## by Google ########################
        // define your languages by adding the locale to the ArrayList.
        // where the first language is the default language. e.g. Player language not taken into account, server creates new spokesman language
        Sprache.add("en");  // => Sprache.get(0)
        Sprache.add("de");  // => Sprache.get(1)
        setSprache(Sprache);
        // dieser Teil ist Dynamisch auf die Sprache aufgebaut.
        // im ersten Parameter wird der Name des Textes, wie die Variable in der Sprachdatei heißt und wie er im Code aufgerufen wird, angegeben
        // nun volgen für jede definierte Sprache die Voreinstellungen.
        // !!! zwei Dimensionales Area, bei Komma und Klammern aufpassen !!!
        //######################## by Google ########################
        // this part is dynamically built on the language.
        // the first parameter specifies the name of the text, which is the name of the variable in the language file and how it is called in the code
        // Now the default settings for each defined language.
        // !!! Two Dimensional Area, take care of comma and parentheses !!!        
        Daten = new String[][] { 
            //Name                  Sprache.get(0) => en            Sprache.get(1) => de
            {"DafaultWelcomMsg"     ,"You enter the Server [%s]"    ,"Du betrittst den Server [%s]"},
            {"command_help"         ,"use: \"/mycom help\""         ,"benutze: \"mycom help\""}
        };
        setDaten(Daten);
    }
}

Display More

!!! ACHTUNG -!- WICHTIG !!!
Wenn die SprachAPI aktualisiert wird, prüfe bitte alle weiteren Plugins die SprachAPI verwenden auf NEUE Versionen.

sharkbitefischer · Jan 1st 2018

what does this do? I am not completely clear on it's application. Does this translate everything on the server to another language and how is it activated so everybody doesn't have to see everything in that language or in every language? I like the idea of a translator program but it needs to be able to be turned off or on for each player individually. As I said I do not completely understand what this does or how or why I should use it. I see a lot of semi technical talk on how to do stuff but no clear description of the plugin's use.

This plugin aims to create more plugins with support for different languages.
To promote this, here is a variation on how you can easily get different languages into the output of your plugins.

what does this mean and why should I use this? I am a layman not a programmer. what I get from this is you translate other plugins into other languages but you mention translating the output of other plugins too. Maybe I am missing something.

noci · Jan 1st 2018

no, you can set different languages for your plugin, or server owner can add languages .

###

nein, du kanns für dein Plugin verschiedene Sprachen festlegen, oder Serverbetrwiber können selber Sprschen hinzu fügen.

sharkbitefischer · Jan 1st 2018

so this will make the server broadcast it's announcements in alternate languages? or is this to make new plugins with multiple language controls?

Quote from noci

no, you can set different languages for your plugin, or server owner can add languages .

###

nein, du kanns für dein Plugin verschiedene Sprachen festlegen, oder Serverbetrwiber können selber Sprschen hinzu fügen.

noci · Jan 1st 2018

this make new plugins with multiple language

Bogus · Mar 25th 2018

Moin ;D

Muss ich einen Ordner für die Plugins erstellen ?

Hat sich erledigt ;D

noci · Mar 25th 2018

ein eigener Ordner für die Sprach-API plugins\Sprache\Sprach-API.jar wer schon sinnvoll für die Übersicht im Plugin Ordner. Ist aber nicht zwingend nötig, kann auch in einen Plugin Ordner mit rein. Sprach-API erstellt selber ja keine Datein, wird aber wie ein normales Plugin von Rising World behandelt (darf auch nur einmal geladen werden, sonst Classen Konflikt).

noci · May 2nd 2018

BugFix (1.1.1) ist da.

Forscherdrang · Jun 5th 2018

Hallo noci,
ich wollte mir dein Teleporter plugin installieren, wofür man ja diese Sprach API braucht.
Hier kurz meine Plugin Aufteilung:

Mit den Schildern habe ich mich noch nicht beschäftigt.
Die Tierzucht funktioniert soweit, der Admin Teleport mit Mausrad auf der Karte auch.
Nur Kann ich das Teleport Interface nicht Öffnen. Drücke "P" und nichts passiert. Habe versucht die plugins neu zu laden, aber erfolglos.
Ich gehe also davon aus, das ich bei der Sprach API irgendwas falsch gemacht oder vergessen habe.
Sind sonst in allen Ordnern mehrere Dateien, außer hier:

zum Vergleich/Test hier der Teleport Ordner:

würde dann auch gerne noch die pnb Plugin mit rein nehmen, wo ich zwar schon ein Interface hatte, die Strukturen allerdings alle weiß waren, also im Auswahl Fenster.

noci · Jun 5th 2018

Hi,

in config\System.property die Zeile KEY_GUI=KEY_P ist so eingetragen?

Forscherdrang · Jun 5th 2018

Hier noch ein paar zusätzliche Infos:

- spiele im Einzelspieler Modus

- habe bisher nur die Daten in entsprechende Ordner gepackt (wie oben beschrieben)

- mit altem und neuen Spielstand versucht, Ergebnis blieb gleich

Frage:

- muss ich dieses Programm (IntelliJ IDEA) benutzen ?
- habe es installiert und kurz damit rum gespielt (habe ja keine Ahnung)
- es fehlte wohl eine SDK datei zum fertigstellen
- also habe ich es wieder geschlossen

- muss ich irgendetwas umschreiben? z.B. in einer "ini" Datei
- oder diesen Java Quellcode irgendwo einfügen ?

PS: Sorry wegen dem durcheinander, mein Englisch ist schlecht und vom Programmieren versteh ich nicht viel

Forscherdrang · Jun 5th 2018

Quote from noci

Hi,

in config\System.property die Zeile KEY_GUI=KEY_P ist so eingetragen?

Wo finde ich die denn?

Forscherdrang · Jun 5th 2018

die Datei habe ich gefunden, aber die Zeile nicht

muss ich die selber eintragen?

noci · Jun 5th 2018

EDIT:
Normal nicht, ich probiere mal im SingelPlayer.

Hast du die Debug-Konsole zur verfügung?
Setze mal den Debug=5 dann sollte er sagen ob der Tastendruck ankommt oder nicht.

Habe mir die Aktuellen Versionen der Plugins geholt, die du benutzt. Leider konnte ich den Fehler nicht Reproduzieren.

noci · Jun 5th 2018

Haste Recht, im Singel Player geht garnix.
Ich muss da mal nachsehen und das mal mit Red besprechen.

Forscherdrang · Jun 5th 2018

ist das die Zeile?

Also "false" zu "5" machen

noci · Jun 5th 2018

ne ich meine die im Plugin Orner plugins\Teleport(ation)\config\System.property

Forscherdrang · Jun 5th 2018

Ahhhhhhhhhhh, danke dir

jetzt sind beide zeilen angepasst

Ergebnis aber leider wie vorher, erfolglos. Kein Interface und die Namen bei den Tieren werden nicht mehr alle richtig angezeigt

Forscherdrang · Jun 5th 2018

Leider nicht

Ergebnis wie vorher, erfolglos. Kein Teleport Interface und die Namen bei den Tieren werden nicht mehr alle richtig angezeigt

Forscherdrang · Jun 5th 2018

bei dem Plugin Kommando Schilder ist ebenfalls eine "config\System.property" datei enthalten

muss ich die "debug" Zeile dort auch auf 5 setzen ?
- wegen eventuelle Konflikte oder so was

Participate now!