Densyakunのブログ

Qiitaもやってます: https://qiita.com/Densyakun

【Spigot】Bukkitプラグインの作り方講座 - プラグインの作成(IntelliJ IDEA)

 

今回は実際に簡単なプラグインを作成します。

この作業はプラグインごとに行いますので、覚えてください。

 

プロジェクトの作成

まずプロジェクトを作成します。

この作業は、作成するBukkitプラグインごとに行います。

 

プロジェクトを開いていない画面で「新規プロジェクトの作成」をクリックします。

左のメニューから「Minecraft」を選択します。

 

この記事ではBukkit(Spigot)プラグインを作成しますので、

Spigot Plugin」にチェックを入れます。

(「Bukkit Plugin」は旧バージョンのものです)

次へを押します。

 

ビルド設定

グループ IDは一般的に、自分のサイトなどのアドレスを逆にしたもの(「densyakun.github.io」であればio.github.densyakun)が多いです。

誰が作ったものかを書くという感じです。

また、グループ IDは全て小文字にして下さい。

 

プログラミングをしているとパッケージが増えていきますので他のとかぶらないように名前を付ける必要があります。

私はプラグイン開発以外にも色々やっているので、io.github.densyakun.bukkitといった感じにしています。

 

アーティファクト IDプラグインを書きます。

頭文字が大文字になるようにしてください。

 

この記事ではGradleを使います。

右の「Maven」をクリックして、「Gradle」を選択してください。

また、「前へ」を押して前の画面に戻ると設定が戻ってしまうので注意してください。

 

次へを押します。

 

プラグインの設定

右のMinecraft Versionからマインクラフトのバージョンを選択してください。

特に古いバージョンでなければ、基本的に新しいバージョンで問題ありません。

Bukkitプラグインは対応していれば、異なるバージョンでも使用できます。

 

ここで設定する内容はplugin.ymlと同じものになります。

Plugin.ymlの設定一覧 - Minecraft Modding Wiki

 

次へを押します。

 

最後にお好みのプロジェクト名を書いて完了を押してください。

するとプロジェクトが作成されます。

 

Gradleにより作成されたソースフォルダは、

クラスなどを入れる方が、src > main > java で、

config.ymlなどをいれる方が、src > main > resources です。

 

パッケージ名は、グループ IDとアーティファクト IDを小文字にしたものを合わせたものになります。

プラグインのメインクラスはJavaPluginを継承したプラグイン名のクラスが、

このパッケージの中に作成されているので、

それを開きます

 

すでに色々書かれています。

onEnable関数はプラグインが有効になるときに実行されます。

onDisable関数はプラグインが無効になるときに実行されます。

 

Jarファイルを作成する

プロジェクトフォルダにあるbuild.gradleを開きます。

ファイルに以下のテキストを追加します。

jar {
}

IntelliJ IDEAでは、編集は自動的に保存されます。

編集したら右下に「変更をインポート」と表示されますので押します。

 

右上のトンカチのボタンをクリックしてビルドします。

次に、IDEの内蔵エディタで先程追加した jar{} の、

左にある行数の横にある三角をクリックして実行すると、Jarファイルが作成されます。

作成されたJarファイルは、プロジェクトフォルダ > build > libs にあります。

これが完成したプラグインとなります。

 

Gradleを日本語のコードに対応する

日本語を含む文字列などをコードに追加すると、

Gradleでビルドする際にエラーが発生してしまいます。

これは文字コードの関係で起きています。

 

build.gradle内に以下のコードを追加します。

compileJava.options.encoding = 'UTF-8'

(targetCompatibility = '1.8'の下辺り、8行目辺りに追加すると良い) 

 

編集したら右下に「変更をインポート」と表示されるので押してください。

これでビルドするとできます。

 

プラグインを導入する

完成したプラグインのJarファイルを、

Bukkitサーバーのpluginsフォルダに入れて、

サーバーを起動します。

/pl コマンドを実行して、作成したプラグインが緑色で表示されていれば完了です。

赤色で表示されている場合は、前提プラグインが入っていないなどプラグインが無効になっています。

 

/version (プラグイン名) コマンドでプラグインのバージョンなどの情報を見ることができます。

 

これでプラグインを作ることが出来ました。

実際に作ったプラグインが動いているのを見ると達成感を感じますね。 

次は、作成したプラグインをいじって、機能を追加していきましょう!

 

記事一覧に戻る