Plugin-Erstellung/Java/Eclipse Entwicklungsumgebung: Unterschied zwischen den Versionen
| Zeile 57: | Zeile 57: | ||
import net.risingworld.api.objects.Player; | import net.risingworld.api.objects.Player; | ||
public class | public class MyPluginClass extends Plugin implements Listener | ||
{ | { | ||
@Override | @Override | ||
Version vom 25. April 2024, 10:48 Uhr
 |
* Diese Seite ist in Bearbeitung * This page is in progress *
Bitte schaue später noch einmal vorbei, um weitere Änderungen zu erfahren.
Please check back later for additional changes.
|
ToDo: plugin.yml, projectinfo.txt, Bilder, Screenshots ...
Erstellung eines JAVA Plugin-Projekts für Rising World Plugin-API in Eclipse
In diesem Tutorial wird beschrieben, wie man ein JAVA Plugin-Projekt für die Rising World Plugin-API in der Entwicklungsumgebung Eclipse erstellt. Eclipse ist eine weit verbreitete und leistungsfähige Entwicklungsumgebung, die sich ideal für Java-Projekte eignet, einschließlich der Entwicklung von Plugins für Spiele wie Rising World.
Eclipse installieren
Zuerst muss sichergestellt werden, dass Eclipse auf dem Computer installiert ist. Eclipse kann von der offiziellen Webseite eclipse.org/downloads/packages heruntergeladen werden. Für die Entwicklung von Java-Anwendungen sollte die "Eclipse IDE for Java Developers" Version ausgewählt werden.
Java Development Kit (JDK) installieren
Für die Plugin-Entwicklung ist das Java Development Kit (JDK) erforderlich.
JDK 20 wird empfohlen, da es mit der Rising World Plugin-API kompatibel ist.
Es ist empfehlenswert, es aus dem Spielverzeichnis zu verwenden: _New Version/Data/Java/JDK .
Es kann alternativ von jdk.java.net/20 heruntergeladen werden.
Nach der Installation von der JDK muss in Eclipse der Pfad zum JDK konfiguriert werden.
Neues Projekt anlegen
- Eclipse öffnen und auf "File" > "New" > "Java Project" klicken.
- Im Dialogfeld "New Java Project" den Projektnamen eingeben, z.B. "RisingWorldPlugin".
- Bei der JRE auf "Use an execution environment JRE:" gehen und die passende Java-Version auswählen, die mit der Rising World API kompatibel ist.
- Klicken Sie auf "Next" und dann auf "Finish".
Einbindung der Rising World Plugin-API
Das Spiel wird bereits mit der API-Bibliothek (PluginAPI.jar) und dem entsprechenden JavaDoc (javadoc.zip) ausgeliefert,
beides ist im
Spielverzeichnis unter 
RisingWorld\_New Version\Data\SDK\ zu finden.
Wenn Sie die API aus dem Spielverzeichnis verwenden, verwendet Ihre IDE immer automatisch die neueste API.
Unter diesem Link gibt es eine Online-Version des neuesten JavaDoc: API Packages.
Einbindung:
- Im Eclipse-Projektbaum mit der rechten Maustaste auf das Projekt klicken und "Properties" auswählen.
- Zum Bereich "Java Build Path" navigieren und zum Reiter "Libraries" wechseln
- Auf "Add External JARs..." klicken und die PluginAPI.jar Datei auswählen
- Auf "Apply and Close" klicken
Plugin erstellen
Im folgenden Beispiel nennen wir dein Paketnamen MainErstesPlugin.
- Rechtsklick auf das Projekt > "New" > "Package" und einen Paketnamen wie net.mypackage.mainerstesplugin angeben
- Auf "Finish" klicken
- Rechtsklick auf das neu erstellte Paket > "New" > "Class" und einen Klassennamen MainErstesPlugin eingeben
- Auf "Finish" klicken und die Klasse wird erstellt
- Folgenden Code als Beispiel eingeben, um mit der Entwicklung zu beginnen:
package net.mypackage.mainerstesplugin;
import net.risingworld.api.Plugin;
import net.risingworld.api.events.EventMethod;
import net.risingworld.api.events.Listener;
import net.risingworld.api.objects.Player;
public class MyPluginClass extends Plugin implements Listener
{
@Override
public void onEnable()
{
System.out.println("Mein Plugin geladen!");
registerEventListener(this);
}
@Override
public void onDisable()
{
System.out.println("Mein Plugin entladen!");
}
@EventMethod
public void onPlayerSpawn(PlayerSpawnEvent event)
{
Player player = event.getPlayer();
}
}
Projektname
Der Projektnamen ist der Name, der einem Projekt in Eclipse zugewiesen wird. Er wird bei der Erstellung eines neuen Projekts festgelegt und dient dazu, das Projekt innerhalb der Eclipse-Arbeitsumgebung zu identifizieren. Der Projektnamen kann aus Buchstaben, Zahlen und einigen Sonderzeichen bestehen, aber es wird empfohlen, keine Leerzeichen zu verwenden, da Eclipse dies nicht unterstützt.
Paketname
Der Paketname ist der Name, der einem Paket innerhalb eines Projekts zugeordnet wird. Ein Paket ist eine logische Gruppierung von Klassen und anderen Ressourcen in einem Projekt. Der Paketname wird in Kleinbuchstaben geschrieben und sollte eine Domain-Namenskonvention verwenden, z. B. com.example.myproject. Dies hilft, Konflikte zwischen Paketnamen zu vermeiden und die Organisation von Klassen und Ressourcen zu erleichtern. Klassen befinden sich immer in Paketen. Methoden und Klassen können vollqualifiziert (d.h. mit dem Paketnamen) benannt werden.
Es ist wichtig, den Paketnamen in Kleinbuchstaben zu schreiben,
da Java und Eclipse die Groß- und Kleinschreibung von Paketnamen nicht unterscheiden.
plugin.yml Datei
Die Definitionsdatei "plugin.yml" ist notwendig.
Hier ist ein Beispiel für die "plugin.yml" Definitionsdatei:
name: MyPluginName
main: net.mypackage.mainerstesplugin.MyPluginClass
version: 0.0.1
author: <AuthorName>
team: <your team, optional>
description: "RW Plugin description ..."
loadorder: 0
license: MIT
website: http://www.optional_homepage_url.com
Siehe auch: Rising World Forum: Create a Plugin
Plugin kompilieren und testen
Um das Plugin zu kompilieren, einfach das Projekt in Eclipse bauen.
Die generierte .jar-Datei soll dann im
Plugins-Verzeichnis RisingWorld\_New Version\Plugins\ platziert werden, um das Plugin zu testen.
Dynamisch kompilieren
ToDo: dynamisch kompilieren über eine "projectinfo.txt" ... siehe: RW Forum: Antwort von red51
Weiterentwicklung und Debugging
Weiterhin ist es empfehlenswert, regelmäßig neue Features zu implementieren, das Plugin zu testen und Fehler zu beheben. Eclipse bietet umfassende Debugging-Tools, die dabei helfen können, Probleme effizient zu identifizieren und zu lösen. ...
