bukkit Tutorial
Erste Schritte mit Bukkit

Bemerkungen

Versionen

Ein Plugin erstellen

Voraussetzungen

• JDK 7 oder höher (empfohlen: JDK 8+)

Bukkit als Abhängigkeit hinzufügen

Die einfachste Methode zum Hinzufügen der Bukkit-API zu Ihrem Projekt besteht darin, die Bukkit.jar direkt aus dem Spigot-Repository herunterzuladen und sie dem Klassenpfad Ihres Projekts hinzuzufügen. Ältere Versionen von Bukkit finden Sie im Bukkit-Repository .

Die andere besteht darin, es als Maven-Abhängigkeit hinzuzufügen, indem Sie die folgenden Zeilen zu Ihrer pom.xml hinzufügen:

<repositories>
    <repository>
        <id>spigot-repo</id>
        <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
    </repository>
</repositories>
<dependencies>
    <!--Bukkit API-->
    <dependency>
        <groupId>org.bukkit</groupId>
        <artifactId>bukkit</artifactId>
        <version>{VERSION}</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Hauptklasse

Die Hauptklasse des Plugins ist der Einstiegspunkt für Bukkit, um eine Interaktion mit Ihrem Plugin zu laden. Es ist eine Klasse, die JavaPlugin Nur eine Instanz davon sollte von Ihrem Plugin erstellt werden. Es ist üblich, dieser Klasse den gleichen Namen wie Ihr Plugin zu geben.

Hier ist ein Beispiel für eine Hauptplugin-Klasse für das Plugin "MyPlugin":

package com.example.myplugin; //{$TopLevelDomain}.{$Domain}.{$PluginName};

import org.bukkit.plugin.java.JavaPlugin;

public final class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        //Called when the plugin is enabled
        getLogger().info("onEnable has been invoked!");
    }

    @Override
    public void onDisable() {
        //Called when the plugin is disabled
        getLogger().info("onDisable has been invoked!");
    }

}

Um von einer anderen Klasse auf Ihre Plugin-Instanz zuzugreifen, müssen Sie die von Bukkit erstellte Instanz Ihrer MyPlugin-Klasse speichern, sodass sie von außerhalb der Klasse zugänglich ist.

public class MyPlugin extends JavaPlugin {

    private static MyPlugin instance; //Effectively final variable containing your plugin's instance

    public MyPlugin(){
        if(MyPlugin.instance != null) { //Unnecessary check but ensures your plugin is only initialized once.
            throw new Error("Plugin already initialized!");
        }

        MyPlugin.instance = this; //A plugin's constructor should only be called once
    }

    public static MyPlugin getInstance(){ //Get's your plugin's instance
        return instance;
    }

    //your other code...
}

MyPlugin.getInstance() von einer anderen Klasse auf Ihre Hauptklasse zuzugreifen, verwenden Sie einfach MyPlugin.getInstance()

public class MyOtherClass {

    public void doSomethingWithMainClass(){
        MyPlugin.getInstance().getLogger().info("We just used MyPlugin");
    }

}

Plugin.yml erstellen

Die Datei plugin.yml befindet sich im Stammverzeichnis der endgültigen JAR-Datei und stellt Bukkit wichtige Informationen zum Laden des Plugins bereit. Das einfachste plugin.yml sieht so aus

name: {$PluginName}               //The name of the plugin
main: {$PackageName}.{$MainClass} //The fully qualified name of the main class.
version: {$Version}               //The plugin's version

Zum Beispiel mit der obigen Klasse MyPlugin

name: MyPlugin
main: com.example.myplugin.MyPlugin
version: 1.0

Erstellen Sie einen Testserver unter Windows

Um einen Server erstellen zu können, benötigen Sie den Zapfen oder die Bukkit-JAR-Datei. Beziehen Sie sich auf das Thema der Version , um Ihr Glas auszuwählen

1. Erstellen Sie zuerst einen neuen Ordner. Fügen Sie in diesem Ordner die JAR-Datei spigot / bukkit ein.
2. Klicken Sie mit der rechten Maustaste in den Ordner und wählen Sie Neu> Textdokument.
3. Benennen Sie das neue Dokument start.bat, klicken Sie mit der rechten Maustaste darauf und klicken Sie auf Bearbeiten.
4. Fügen Sie den folgenden Code hinzu:

@echo off
java -Xms512M -Xmx1G -XX:+UseConcMarkSweepGC -jar {YOUR_JAR.jar}
pause

Vergessen Sie nicht, {YOUR_JAR.jar} für das heruntergeladene Jar zu ändern, bevor Sie diese Themen starten.

5. Sie können -Xms bearbeiten, um den minimal zulässigen Arbeitsspeicher zu ändern (Bsp .: -Xms1024M = 1024 MB, -Xms1G = 1 GB). Sie können auch -Xmx bearbeiten, um den maximal zulässigen Arbeitsspeicher zu ändern. Stellen Sie sicher, dass das Maximum größer als das Minimum ist.
6. Speichern Sie die Datei, schließen Sie das Fenster und starten Sie Ihre start.bat Datei. Ihr Server sollte sich jetzt öffnen. Um den Server auszuführen, müssen Sie die EULA akzeptieren.
7. Wenn Sie mit der EULA einverstanden sind, öffnen eula.txt die eula=false eula.txt Ändern Sie eula=false in eula=true Klicken Sie auf "Speichern". Nun sollten Sie in der Lage sein, Ihren Server zu starten.
8. Um eine Verbindung zu Ihrem Server start.bat , führen Sie start.bat , öffnen Sie Minecraft, fügen Sie einen Server hinzu und geben Sie localhost als IP ein.

BuildTools

Was ist es?

BuildTools.jar ist eine Lösung zum Erstellen von Bukkit, CraftBukkit, Spigot und der Spigot-API. Das alles geschieht auf Ihrem Computer! Ein paar vorausgesetzte Programme sind erforderlich, aber die folgenden Anweisungen führen Sie durch alles, was Sie tun müssen.

Voraussetzungen

Für die Verwendung von BuildTools sind zwei Anwendungen erforderlich: Git und Java.

Windows

Git

Damit BuildTools unter Windows ausgeführt werden kann, müssen Sie Git installieren. Für Windows wird es über git-scm verteilt, das hier heruntergeladen werden kann . Installiere es wo du willst, es wird git bash zur Verfügung stellen, die zum Ausführen der BuildTools-JAR verwendet wird. Schlagen Sie einfach weiter, wenn Sie das Installationsprogramm ausführen.

Java

Laden Sie JRE 8 hier herunter und installieren Sie es. Schlagen Sie einfach weiter, wenn Sie das Installationsprogramm ausführen.

Linux

Sowohl git und Java als auch util-Befehle können mit einem einzigen Befehl über Ihren Paketmanager installiert werden.

Debian / Ubuntu: sudo apt-get install git openjdk-7-jre-headless tar

CentOS / RHEL: sudo dnf install git java-1.7.0-openjdk-devel tar

Bogen: pacman -S jdk8-openjdk git

Mac

Git kann heruntergeladen werden von: http://sourceforge.net/projects/git-osx-installer/files/

Möglicherweise muss Java von der verteilten Apple-Version aktualisiert werden, und selbst wenn es zuvor aktualisiert wurde, muss es möglicherweise für die Verwendung der Shell verknüpft werden. Bitte befolgen Sie die hier aufgeführten Schritte: https://gist.github.com/johan/10590467

BuildTools ausführen

1. Laden Sie BuildTools.jar von https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar herunter.

2. Öffnen Sie Ihr Terminal, wenn Sie mit Linux arbeiten, oder git bash unter Windows.

   1. Git-bash ist auf dem Desktop oder im Startmenü unter dem Namen "git bash" zu finden. Sie können es auch öffnen, indem Sie mit der rechten Maustaste auf etwas klicken, da es jetzt ein Element in Ihrem Kontextmenü ist.

3. Navigieren Sie zu dem Ort, an dem Sie BuildTools.jar heruntergeladen haben, oder verwenden Sie die Befehlszeile, um die JAR-Datei in Ihr aktuelles Verzeichnis herunterzuladen.

   1. Unter Windows können Sie entweder den Befehl cd verwenden, um Verzeichnisse zu ändern, oder Sie können mit der rechten Maustaste auf den leeren Bereich des Ordners klicken, in dem sich BuildTools.jar befindet (klicken Sie NICHT auf BuildTools.jar), und klicken Sie auf "git bash". Dadurch wird es geöffnet in Ihrem aktuellen Verzeichnis.

4. Führen Sie BuildTools.jar vom Terminal aus (doppelklicken Sie nicht auf BuildTools.jar), indem Sie folgende Schritte ausführen:

   1. Führen Sie unter Linux git config --global --unset core.autocrlf aus, und führen Sie dann java -jar BuildTools.jar in bash oder einer anderen geeigneten Shell aus.
   2. Führen Sie unter Windows den folgenden Befehl innerhalb des geöffneten git bash-Fensters aus: java -jar BuildTools.jar Bitte beachten Sie, dass Sie über BuildTools # 35 oder höher verfügen, ältere Versionen funktionieren nicht.
   3. Führen Sie auf dem Mac die folgenden Befehle aus und exportieren Sie MAVEN_OPTS = "- Xmx2G" java -Xmx2G -jar BuildTools.jar
   4. Wenn Sie eine ältere Version benötigen, können Sie die Version mit --rev als Argument für BuildTools angeben, beispielsweise für 1.8.8: java -jar BuildTools.jar --rev 1.8.8

5. Warten Sie, wie es Ihre Gläser baut. In wenigen Minuten sollten Sie frisch zusammengestellte Gläser haben!

6. Sie finden CraftBukkit und Spigot in demselben Verzeichnis, in dem Sie die BuildTools.jar ausgeführt haben (für Minecraft Version 1.10 wären dies Craftbukkit-1.10.jar und Spigot-1.10.jar). Sie finden die Spigot-API unter \ Spigot \ Spigot-API \ target \ (für Minecraft Version 1.10 wäre dies Spigot-api-1.10-R0.1-SNAPSHOT.jar).