【Spigot】Bukkitプラグインの作り方講座 - 開発環境の構築(Eclipse)
今回は最初に、Bukkitプラグインの開発環境を構築します。
Bukkitプラグインはプログラミング言語「Java」で出来ています。
今回は、Javaの統合開発環境(IDE)で有名な「Eclipse」を使用します。
注意
この講座ではWindowsでの方法について解説しています。Windows以外では導入方法が異なりますので、ご注意ください。
Eclipseのダウンロード、インストール
公式のeclipseは日本語に対応していないため、
こちらのサイトから日本語版をダウンロードします。
eclipse日本語版: http://mergedoc.osdn.jp/
お好みのバージョンを選択して、JavaのFull Editionをダウンロードしてください。
ダウンロードが終わったらzipを展開して下さい。
中にある「pleiades-…」フォルダの中にあるeclipseのフォルダを開くと、
中にeclipse.exeがあるのでそれを開くとeclipseを起動します。
eclipseを起動するとスプラッシュ画面が表示されます。
初回起動時のみしばらく時間がかかります。
eclipse4.6(日本語版)のスプラッシュ画面
しばらくすると「Eclipse ランチャー」画面が表示され、
プロジェクトを管理するフォルダ「ワークスペース」を設定します。
「OK」を押すと、eclipseの起動が完了し画面が表示されます。
これで、eclipseが導入できました。
Spigotサーバーを立てる
次は、Spigotサーバーを立てます。
Spigotとは、更新及び公開が停止しているBukkitの派生版で、Bukkitと同様に使用でき、さらに多くの機能が追加されているものです。
プラグイン開発ではBukkitとSpigotに一部違いがあるため注意が必要です。
Spigotサーバーをダウンロード
次に、プラグインを実行するためのサーバーであるSpigotをダウンロードします。今回は1.9.4のサーバー及びプラグインを作りますが、1.9.4じゃなくても構いません。
Spigotダウンロードサイト(非公式): https://getbukkit.org/download/spigot
非公式サイトですが、公式サイトだとビルドツールとかgitとかなんだかんだでめんどくさいので、こちらの方が簡単にサーバーが立てられます。
ダウンロードしたいバージョンの右にあるDownloadボタンを押します。(横のCreate a Serverは押さないで下さい)
すると次のページに行き、少し下にスクロールすると広告に囲まれたリンクがあるのでそれを開いてダウンロードします。
ダウンロードしたら、好きなところにサーバーのフォルダを作り、その中にダウンロードしたjarファイルを入れます。(この時、間違えて開かないで下さい)
.jarファイルをそのまま開いてしまうと、
バックグラウンドで見えないサーバーを開いてしまいます。
なお、間違えて開いてしまった場合は、
タスクマネージャーからjavawを停止してください。
サーバーをたてる準備
サーバーを実行するためには、JDKのインストール、環境変数の設定が必要です。
こちらを参考にして下さい。
https://eng-entrance.com/java-install-jdk-windows
batファイルを作成する
次に、サーバーのフォルダの中に.batファイルを作成して、サーバーを可視化します。(Windowsの場合)
ファイル名に拡張子が表示されない場合は、エクスプローラーの設定を変更して下さい。
フォルダを右クリックして、 新規作成>テキストドキュメント を選択して、ファイル名を「start.bat」にします。
この時警告が出るはずですが、問題ないので続行して下さい。
ファイル名のstartはお好みの文字にしても構いません。”.txt”は消して下さい。
作成したbatファイルを右クリックして「編集」を押して下さい。(お好みのテキストエディタがあればそれを使って開いて下さい)
するとメモ帳が出てくるので以下のを書いてください。
コピペで入力しても構いませんので、入力が完了したら保存して下さい。
@ECHO OFF java -Xms128M -Xmx1024M -jar spigot-xxx.jar PAUSE
(spigot-xxx.jarにはダウンロードしたjarファイルのファイル名を入力)
javaはjarファイルを実行します。つまりサーバーを実行する処理が書かれています。
-Xms
は最小メモリ使用量、-Xmx
は最大メモリ使用量です。1024Mは1GBと同じです。
-Xms と -Xmx は省略しても構いませんし、-Xmxだけ書いてもいいです。
省略した場合はデフォルトで最大1GBを使用します。大したワールドデータや50個を超えるほどの大量のプラグインを使用しなければ1GBで十分です。
・注意: MBやGBなどの単位は-Xms
と-Xmx
の単位を揃えて下さい。
PAUSE
は処理を停止して、キーボードを押したときに処理を再開するものです。
PAUSE の上にjavaがあるのでサーバーが実行されます。
サーバーが停止すると PAUSE により処理を停止してキーボードを押すとコンソールが消えます。
PAUSE が無いとサーバーが停止したときにすぐにコンソールが消えます。
@ECHO OFF
は特に気にしなくていいです。
(詳しく説明すると、@ECHO はbatが実行するコマンド【今回の場合はjava
やPAUSE
など】をコンソールに表示するかどうかを設定するものです)
サーバーを起動する
次に、start.batを実行してサーバーを起動します。
すると黒い画面に白い文字が表示されたコンソール画面が出てきます。
すると、「Stopping server」と表示されサーバーが停止しました。
初回起動時には利用規約に同意する必要があります。
サーバーを開くとサーバーフォルダにサーバーのファイルが生成されているので、
利用規約に同意するにはサーバーフォルダに生成されたeula.txtを編集し
eula=false
をeula=true
に書き換えて下さい。
そしてもう一度start.batを起動するとサーバーが起動できます。
コンソールではコマンドを入力することが出来ます。
「stop」と入力するとサーバーを停止できます。
その他コマンドについてはhttps://www.spigotmc.org/wiki/spigot-commands/をご覧下さい。
・ここではポート開放のやり方などは説明しません。
今回はBukkitプラグイン開発環境の構築を行いました。
続いて実際にプラグインを作っていきます。