bukkit Handledning
Komma igång med bukkit

Anmärkningar

versioner

Skapa ett plugin

förutsättningar

• JDK 7 eller högre (rekommenderas: JDK 8+)

Lägga till Bukkit som en beroende

Den enklaste metoden för att lägga till Bukkit API till ditt projekt är att ladda ner Bukkit.jar direkt från Spigot Repository och lägga till det i projektets klassväg. Äldre versioner av Bukkit finns på Bukkit Repository .

Det andra är att lägga till det som ett Maven-beroende genom att lägga till följande rader i din pom.xml :

<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>

Huvudklass

Plugins huvudklass är ingångspunkten för Bukkit för att ladda en interaktion med din plugin. Det är en klass som utökar JavaPlugin och endast en instans av den ska skapas av din plugin. I konvention är det bra att ge denna klass samma namn som din plugin.

Här är ett exempel på en huvudplugin-klass för 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!");
    }

}

För att komma åt din insticksinstans från en annan klass måste du lagra instansen för din MyPlugin-klass som skapats av Bukkit så att den är tillgänglig utanför klassen.

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...
}

För att komma åt din huvudklass från en annan klass använder du bara MyPlugin.getInstance()

public class MyOtherClass {

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

}

Skapa ett plugin.yml

Plugin.yml-filen går i roten till din slutliga jarfil och tillhandahåller viktig information till Bukkit för att ladda ditt plugin. Det enklaste plugin.yml ser ut så här

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

Till exempel med ovanstående MyPlugin-klass

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

Skapa en testserver på Windows

För att kunna skapa en server måste du ha spigot eller bukkit jar-filen. Återgå till versionens ämne för att välja din burk

1. Skapa först en ny mapp. I den mappen lägger du spigot / bukkit-burkfilen.
2. Högerklicka i mappen och välj Nytt> Textdokument.
3. Namnge det nya dokumentet start.bat, högerklicka på det och klicka på Redigera.
4. Lägg till följande kod:

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

Glöm inte att byta {YOUR_JAR.jar} för den burk du laddade ner innan du startar dessa ämnen.

5. Du kan redigera -Xms att ändra det minsta tillåtna RAM (Ex: -Xms1024M = 1024MB, -Xms1G = 1GB). Du kan också redigera -Xmx att ändra det maximalt tillåtna RAM- -Xmx . Se till att det maximala är större än minimum.
6. Spara filen, stäng fönstret och starta din start.bat fil. Din server bör nu öppnas. För att köra servern måste du acceptera EULA .
7. Om du accepterar EULA , öppna eula.txt ändra eula=false till eula=true Klicka på "Spara" och du bör nu kunna starta din server.
8. För att ansluta till din server kör du start.bat , öppnar Minecraft, lägger till en server och sätter localhost som IP.

BuildTools

Vad är det?

BuildTools.jar är en lösning för att bygga Bukkit, CraftBukkit, Spigot och Spigot-API. Allt detta görs på din dator! Några förutsättningar är nödvändiga, men instruktionerna nedan leder dig genom allt du behöver göra.

förutsättningar

Det finns två applikationer som krävs för att använda BuildTools: Git och Java.

Windows

Git

För att BuildTools ska kunna köras på Windows måste du installera Git. För Windows distribueras det via git-scm, som kan laddas ner här . Installera det där du vill, det kommer att ge git bash, som kommer att användas för att köra BuildTools-burk. Fortsätt bara slå nästa när du kör installationsprogrammet.

Java

Ladda ner JRE 8 härifrån och installera. Fortsätt bara slå nästa när du kör installationsprogrammet.

Linux

Både git och Java, såväl som util-kommandon, kan installeras med ett enda kommando via din pakethanterare.

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

Båge: pacman -S jdk8-openjdk git

Mac

Git kan laddas ner från: http://sourceforge.net/projects/git-osx-installer/files/

Java kan behöva uppdateras från den Apple-distribuerade versionen, och även om den tidigare har uppdaterats kan det behövas länkas för skalanvändning. Följ stegen som hittas här: https://gist.github.com/johan/10590467

Kör BuildTools

1. Ladda ner BuildTools.jar från https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar .

2. Öppna din terminal om du är på Linux eller git bash på Windows.

   1. Git bash finns på skrivbordet eller i Start-menyn under namnet "git bash". Det är också möjligt att öppna det genom att högerklicka på vad som helst, eftersom det nu är ett objekt i snabbmenyn.

3. Navigera till där du laddade ner BuildTools.jar, eller använd kommandoradsläget för att ladda ner burken till din nuvarande katalog.

   1. I Windows kan du antingen använda cd-kommandot för att ändra kataloger, eller så kan du högerklicka på det tomma utrymmet i mappen där BuildTools.jar är (INTE klicka på BuildTools.jar själv) och klicka på "git bash", som öppnar den i din nuvarande katalog.

4. Kör BuildTools.jar från terminalen (Dubbelklicka inte på BuildTools.jar) genom att göra följande:

   1. På Linux kör git config - global --unset core.autocrlf, kör sedan java -jar BuildTools.jar i bash eller ett annat lämpligt skal.
   2. På Windows kör kommandot nedan inuti git bash-fönstret som öppnades: java -jar BuildTools.jar Observera att det krävs att du har BuildTools # 35 eller senare, äldre versioner fungerar inte.
   3. På Mac kör nedanstående kommandon, exporter MAVEN_OPTS = "- Xmx2G" java -Xmx2G -jar BuildTools.jar
   4. Om du behöver äldre version kan du ange versionen med --rev argument till BuildTools, till exempel för 1.8.8: java -jar BuildTools.jar --rev 1.8.8

5. Vänta när det bygger dina burkar. Om några minuter bör du ha nyligen sammanställda burkar!

6. Du kan hitta CraftBukkit och Spigot i samma katalog som du körde BuildTools.jar i (för minecraft version 1.10, de skulle vara craftbukkit-1.10.jar och spigot-1.10.jar). Du hittar Spigot-API i \ Spigot \ Spigot-API \ target \ (för minecraft version 1.10 skulle det vara spigot-api-1.10-R0.1-SNAPSHOT.jar).