bukkit Samouczek
Rozpoczęcie pracy z bukkit

Uwagi

Wersje

Tworzenie wtyczki

Wymagania wstępne

• JDK 7 lub wyższy (zalecane: JDK 8+)

Dodanie Bukkit jako zależności

Najprostszą metodą dodania interfejsu API Bukkit do projektu jest pobranie pliku Bukkit.jar bezpośrednio z repozytorium Spigot i dodanie go do ścieżki klas projektu. Starsze wersje Bukkit można znaleźć w repozytorium Bukkit .

Drugim jest dodanie go jako zależności Maven przez dodanie następujących wierszy do 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>

Główna klasa

Główną klasą wtyczki jest punkt wejścia dla Bukkit, aby załadować interakcję z wtyczką. Jest to klasa, która rozszerza JavaPlugin i tylko jedna jej instancja powinna zostać utworzona przez wtyczkę. Zgodnie z konwencją dobrze jest nadać tej klasie taką samą nazwę jak wtyczka.

Oto przykład głównej klasy wtyczki dla wtyczki „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!");
    }

}

Aby uzyskać dostęp do instancji wtyczki z innej klasy, musisz przechowywać instancję swojej klasy MyPlugin utworzonej przez Bukkit, aby była dostępna spoza klasy.

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

Następnie, aby uzyskać dostęp do głównej klasy z innej klasy, wystarczy użyć MyPlugin.getInstance()

public class MyOtherClass {

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

}

Tworzenie plugin.yml

Plik plugin.yml znajduje się w katalogu głównym końcowego pliku jar i dostarcza Bukkitowi niezbędnych informacji do załadowania wtyczki. Najprostszy plugin.yml wygląda następująco

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

Na przykład z powyższą klasą MyPlugin

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

Utwórz serwer testowy w systemie Windows

Aby móc utworzyć serwer, musisz mieć plik spigot lub jar jar bukkit. Zapoznaj się z tematem wersji, aby wybrać słoik

1. Najpierw utwórz nowy folder. W tym folderze umieść plik jar spigot / bukkit.
2. Kliknij folder prawym przyciskiem myszy i wybierz Nowy> Dokument tekstowy.
3. Nazwij nowy dokument start.bat, kliknij go prawym przyciskiem myszy i kliknij Edytuj.
4. Dodaj następujący kod:

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

Nie zapomnij zmienić {YOUR_JAR.jar} dla słoika pobranego przed rozpoczęciem tych tematów.

5. Możesz edytować -Xms aby zmienić minimalną dozwoloną pamięć RAM (np .: -Xms1024M = 1024 MB, -Xms1G = 1 GB). Możesz także edytować -Xmx aby zmienić maksymalną dozwoloną pamięć RAM. Upewnij się, że maksimum jest większe niż minimum.
6. Zapisz plik, zamknij okno i uruchom plik start.bat . Twój serwer powinien się teraz otworzyć. Aby uruchomić serwer, musisz zaakceptować umowę EULA .
7. Jeśli zgadzasz się na warunki umowy EULA , otwórz eula.txt zmień eula=false na eula=true Kliknij „Zapisz”, a następnie powinieneś być w stanie uruchomić serwer.
8. Aby połączyć się z serwerem, uruchom start.bat , otwórz Minecraft, dodaj serwer i start.bat localhost jako adres IP.

BuildTools

Co to jest?

BuildTools.jar to rozwiązanie do budowania Bukkit, CraftBukkit, Spigot i Spigot-API. Wszystko to odbywa się na komputerze! Koniecznych jest kilka programów wstępnych, ale poniższe instrukcje poprowadzą Cię przez wszystko, co musisz zrobić.

Wymagania wstępne

Do korzystania z BuildTools potrzebne są dwie aplikacje: Git i Java.

Windows

Git

Aby BuildTools działał w systemie Windows, musisz zainstalować Git. W systemie Windows jest dystrybuowany za pośrednictwem git-scm, który można pobrać tutaj . Zainstaluj go tam, gdzie chcesz, zapewni git bash, który zostanie użyty do uruchomienia słoika BuildTools. Po prostu uderzaj dalej podczas uruchamiania instalatora.

Jawa

Pobierz JRE 8 stąd i zainstaluj. Po prostu uderzaj dalej podczas uruchamiania instalatora.

Linux

Zarówno git, jak i Java, a także polecenia util, można zainstalować za pomocą jednego polecenia za pomocą menedżera pakietów.

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

Arch: pacman -S jdk8-openjdk git

Prochowiec

Git można pobrać ze strony: http://sourceforge.net/projects/git-osx-installer/files/

Java może wymagać aktualizacji z wersji rozproszonej Apple, a nawet jeśli była wcześniej aktualizowana, może być konieczne połączenie z użyciem powłoki. Wykonaj czynności opisane tutaj: https://gist.github.com/johan/10590467

Uruchamianie BuildTools

1. Pobierz BuildTools.jar z https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar .

2. Otwórz terminal, jeśli korzystasz z systemu Linux lub git bash w systemie Windows.

   1. Git bash można znaleźć na pulpicie lub w menu Start pod nazwą „git bash”. Można go również otworzyć, klikając dowolny element prawym przyciskiem myszy, ponieważ jest to teraz element w menu kontekstowym.

3. Przejdź do miejsca, w którym pobrano plik BuildTools.jar, lub użyj wiersza polecenia, aby pobrać słoik do bieżącego katalogu.

   1. W systemie Windows możesz użyć polecenia cd, aby zmienić katalogi, lub możesz kliknąć prawym przyciskiem myszy puste miejsce w folderze, w którym znajduje się BuildTools.jar (NIE klikaj samego BuildTools.jar) i kliknąć „git bash”, który go otworzy w twoim bieżącym katalogu.

4. Uruchom BuildTools.jar z terminala (nie klikaj dwukrotnie BuildTools.jar), wykonując następujące czynności:

   1. W systemie Linux uruchom git config --global --unset core.autocrlf, a następnie uruchom java -jar BuildTools.jar w bash lub innej odpowiedniej powłoce.
   2. W systemie Windows uruchom poniższe polecenie w otwartym oknie git bash: java -jar BuildTools.jar Pamiętaj, że musisz mieć BuildTools # 35 lub nowszy, starsze wersje nie będą działać.
   3. Na komputerze Mac uruchom poniższe polecenia, wyeksportuj MAVEN_OPTS = "- Xmx2G" java -Xmx2G -jar BuildTools.jar
   4. Jeśli potrzebujesz starszej wersji, możesz określić wersję za pomocą argumentu --rev dla BuildTools, na przykład dla 1.8.8: java -jar BuildTools.jar --rev 1.8.8

5. Poczekaj, aż zbuduje twoje słoiki. Za kilka minut powinieneś mieć świeżo skompilowane słoiki!

6. CraftBukkit i Spigot można znaleźć w tym samym katalogu, w którym uruchomiono BuildTools.jar (dla Minecraft w wersji 1.10, będą to Craftbukkit-1.10.jar i Spigot-1.10.jar). Możesz znaleźć Spigot-API w \ Spigot \ Spigot-API \ target \ (dla Minecraft w wersji 1.10 byłby to spigot-api-1.10-R0.1-SNAPSHOT.jar).