bukkit チュートリアル
bukkitを使い始める

備考

バージョン

プラグインの作成

前提条件

• JDK 7以上（推奨：JDK 8以上）

依存関係としてBukkitを追加する

Bukkit APIをプロジェクトに追加する最も簡単な方法は、 Spigot RepositoryからBukkit.jarを直接ダウンロードし、プロジェクトのクラスパスに追加することです。 Bukkitのレガシーバージョンは、 Bukkitリポジトリにあります 。

もう1つは、 pom.xml次の行を追加することで、それをMaven依存関係として追加することです：

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

メインクラス

プラグインのメインクラスは、Bukkitがプラグインとの対話を読み込むためのエントリポイントです。これはJavaPluginを拡張するクラスであり、プラグインによって作成されるインスタンスは1つだけです。規約上、このクラスにはプラグインと同じ名前を付けるのがよいでしょう。

次に、プラグイン "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!");
    }

}

別のクラスのプラグインインスタンスにアクセスするには、クラスの外部からアクセスできるように、Bukkitで作成したMyPluginクラスのインスタンスを格納する必要があります。

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()使用します。

public class MyOtherClass {

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

}

plugin.ymlの作成

plugin.ymlファイルは最終的なjarファイルのルートにあり、プラグインをロードするための重要な情報をBukkitに提供します。最も単純なplugin.ymlは次のようになります

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

たとえば、上記のMyPluginクラス

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

Windowsでテストサーバーを作成する

サーバーを作成するには、spigotまたはbukkit jarファイルが必要です。あなたのjarファイルを選択するにはバージョンのトピックに移動してください

1. まず、新しいフォルダを作成します。そのフォルダに、spigot / bukkit jarファイルを配置します。
2. フォルダ内を右クリックし、新規>テキストドキュメントを選択します。
3. 新しい文書にstart.batという名前を付けて右クリックし、[編集]をクリックします。
4. 次のコードを追加します。

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

これらのトピックを開始する前にダウンロードしたjarの{YOUR_JAR.jar}を変更することを忘れないでください。

5. -Xmsを編集して、許容最小RAMを変更することができます（例：-Xms1024M = 1024MB、-Xms1G = 1GB）。 -Xmxを編集して、最大許容RAMを変更することもできます。最大値が最小値より大きいことを確認してください。
6. ファイルを保存し、ウィンドウを閉じてstart.batファイルを開始します。サーバーが開きます。サーバーを実行するには、 EULAに同意する必要があります 。
7. EULAに同意する場合は、 eula.txtをeula=falseに変更してeula=trueします。「保存」をクリックすると、サーバーを起動できるようになります。
8. サーバーに接続するには、 start.bat実行し、Minecraftを開き、サーバーを追加してIPとしてlocalhostを入力します。

ビルドツール

それは何ですか？

BuildTools.jarは、Bukkit、CraftBukkit、Spigot、およびSpigot-APIを構築するためのソリューションです。これらはすべてあなたのコンピュータ上で実行されます！いくつかの前提条件のプログラムが必要ですが、以下の手順では、必要なすべてをガイドします。

前提条件

BuildToolsを使用するには、GitとJavaの2つのアプリケーションが必要です。

Windows

Git

BuildToolsがWindows上で動作するためには、Gitをインストールする必要があります。 Windowsの場合、git-scmを介して配布されます 。 ここでダウンロードできます 。あなたが好きな場所にインストールすると、BuildTools jarを実行するgit bashが提供されます。インストーラを実行しているときは、次に続けてください。

Java

ここからJRE 8をダウンロードしてインストールしてください。インストーラを実行しているときは、次に続けてください。

Linux

gitとJavaの両方、およびutilコマンドは、パッケージマネージャーを介して1つのコマンドを使用してインストールできます。

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

マック

Gitはhttp://sourceforge.net/projects/git-osx-installer/files/からダウンロードできます。

Javaは、Apple配布バージョンから更新する必要があり、以前に更新された場合でも、シェルの使用のためにリンクする必要があります。次の手順を実行してください： https : //gist.github.com/johan/10590467

BuildToolsの実行

1. BuildTools.jarをhttps://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jarからダウンロードしてください 。

2. Linuxの場合は端末を、Windowsの場合はgit bashを開きます。

   1. Git bashは、デスクトップまたはスタートメニューの "git bash"という名前で見つけることができます。コンテキストメニューの項目になっているので、何かを右クリックして開くことも可能です。

3. BuildTools.jarをダウンロードした場所に移動するか、コマンドラインで現在のディレクトリにjarファイルをダウンロードします。

   1. Windowsでは、cdコマンドを使ってディレクトリを変更するか、BuildTools.jarがあるフォルダの空白部分を右クリック（BuildTools.jarをクリックしないでください）し、 "git bash"をクリックすると開きますあなたの現在のディレクトリにあります。

4. BuildTools.jarをターミナルから実行します（BuildTools.jarをダブルクリックしないでください）。

   1. Linuxではgit config --global --unset core.autocrlfを実行し、bashまたは他の適切なシェルでjava -jar BuildTools.jarを実行します。
   2. Windowsではgit bashウィンドウ内で以下のコマンドを実行します：java -jar BuildTools.jar BuildTools＃35以降が必要ですので、古いバージョンは動作しませんのでご注意ください。
   3. Macでは以下のコマンドを実行し、MAVEN_OPTS = " - Xmx2G"をエクスポートします。java -Xmx2G -jar BuildTools.jar
   4. 古いバージョンが必要な場合は、1.8.8のようにBuildToolsに--rev引数を使用してバージョンを指定できます。java -jar BuildTools.jar --rev 1.8.8

5. あなたの瓶を構築するのを待ってください。数分後に新しくコンパイルした瓶があるはずです！

6. CraftBukkitとSpigotは、BuildTools.jarを実行したディレクトリと同じディレクトリにあります（minecraftバージョン1.10の場合、craftbukkit-1.10.jarとspigot-1.10.jarとなります）。 Spigot-APIは\ Spigot \ Spigot-API \ target \にあります（minecraftバージョン1.10では、spigot-api-1.10-R0.1-SNAPSHOT.jarとなります）。