Skip to content

Instantly share code, notes, and snippets.

@KisaragiEffective

KisaragiEffective/MANUAL.md

Last active June 3, 2019 13:08
Show Gist options
  • Save KisaragiEffective/442de56616d3ed8129d2be8f443ef975 to your computer and use it in GitHub Desktop.
Save KisaragiEffective/442de56616d3ed8129d2be8f443ef975 to your computer and use it in GitHub Desktop.
Download ZIP
How To Contribute Guidance
Raw
MANUAL.md

TODO: 全体的に画質が荒いです

はじめに

ギガンティック☆整地鯖（以下、当鯖）のプラグイン開発をしてみたいけど、Java難しい！助けて！という方に向けての簡単なチュートリアルページです。

前提

知識

本内容は読者が以下を心得ている前提で記述しています。

* Java入門書で学べる最低限の知識
** プログラミング言語自体初めてという方には「スッキリわかるJava入門 第2版 (スッキリシリーズ)」をおすすめします。
* Minecraft Java Editionのゲーム内容
* 問題発生時におけるある程度の自己解決能力
* 基礎的な英文読解能力

環境

本稿では以下の前提で説明しています。更新され古くなった場合は適宜読み替えてください。

  • Windows 10 (64bit)
  • JDK 8 update 144
  • git for windows 2.14.1
  • Spigot 1.12.2
  • XAMPP 7.1.8
  • IntelliJ IDEA 2017.2.3
  • Kotlin 1.2.10

準備するもの

GitHubアカウント

当鯖のプラグインはGitHubを活用して、開発状況の確認や、開発工程の視覚化，効率化を図っています。アカウントをお持ちでない方にはここからアカウントを登録してください。

Minecraft Java Edition

デバッグをするために購入します。minecraft.netから購入

開発環境

Javaのインストール

実行環境とコンパイラ、デバッガーを含んだ開発キット、JDK(Java Development Kit)を導入します。

  1. Oracleにアクセスして、DOWNLOADをクリックしてください。 image alt
  2. 下図の赤丸のチェックを付けて、License Agreementを承認してください。その後、OSにあった実行ファイルをダウンロードしてください。 image alt
  3. ダウンロードした実行ファイルを実行し、インストールウィザードの表示に従いつつインストールを完了してください。
  4. コマンドプロンプトを出してください。
  • Windows 7, 8, 8.1の場合 ** WindowsキーとRキーを同時押しして、出てきたウィンドウにcmdと打ってください。
  • Windows 10の場合 ** コルタナさんに「こま」まで話すと「コマンドプロンプト」が出ますので開いてください。
  1. 開いたら、
java -version

と入力してください。

  1. 下図のように表示されていれば導入成功です。 Success

インストールを正常に完了しているにもかかわらず警告される場合には、環境変数PATHにJDKのディレクトリが登録されていない可能性があります。詳細はPATH 通すなどで検索していただき、JDKのインストールディレクトリ/binがPATHに登録されているかをご確認ください。

統合開発環境のインストール

プログラムはメモ帳やvimを使っても書くことはできますが、複数のプログラムファイルの管理や、コンパイルなどを補助してくれる統合開発環境を使うことでより効率的に開発できます。 本稿では、IntelliJ IDEAをインストールするものとして話を進めます。

  1. JetbrainsのサイトよりIntelliJ IDEAのページへアクセスします。
  2. DOWNLOADを選択し、COMMUNITY版のDOWNLOADを選択してください。 (編注: ULTIMATE版の条件を満たしている場合はそちらをダウンロードすることをおすすめします。)
  3. ダウンロードした実行ファイルを実行し、インストールウィザードに従ってインストールしてください。 (編注: 環境に合わせて適宜変更することをおすすめします。)
  4. 本体を起動してください。
  5. 下のDo not import settingsをクリックして、OKを押します。(編注: もしも古いバージョンのIDEAを使っている場合は、上のラジオボタンをクリックして古いバージョンのディレクトリを選択し、設定をインポートすることもできます。)
  6. ライセンスに同意します。
  7. UIのテーマを決めます。 (編注: あとで変えることができます。)
  • TODO: もっと具体的に *
  1. 最終的にIntelliJ IDEAと中央揃えに表示される画面になるまで、Nextをクリックします。

データベースサーバーの準備

当鯖のプラグインは、各プレイヤーの膨大なデータをデータベースにまとめているため、データベースのサーバーなしでは一部の機能がデバッグできなくなってしまいます。本稿では、ウェブアプリケーションの実行に必要なフリーソフトウェアをパッケージとしてまとめた、apachefriends.orgから提供されているXAMPP (ザンプ)をインストールします。

  1. apachefriends.orgからダウンロードします。
  2. 実行ファイルを実行し、インストールウィザードに従ってインストールしてください。
  3. XAMPPを起動してください。
  4. ApacheとMySQLの欄にあるStartをクリックしてください。 これでデータベースサーバーが起動しました。停止させるときにはStopをクリックしてください。

Spigotの準備

一口にMinecraftのサーバーと言ってもいくつかありますが、本稿ではSpigot (スピゴット)をインストールします。

  1. はじめに、Git for Windowsをgit-for-windows.github.ioよりダウンロードします。
  2. Git for
  3. 次に、以下のコマンドをGit for Windowsで上から順番に送信します
mkdir spigot
cd spigot
curl -L -O https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
java -jar BuildTools.jar --rev 1.12.2
[ -e ./spigot ] && echo Hi Spigot! || echo Not Spigot :\(
pwd #絶対パスの確認
  1. 次に、以下のバッチファイルを作成し、適当な名前でわかりやすいところに保存しておきます。
@ECHO OFF
java -Xmx1024M -Xms1024M -jar spigot-1.12.2.jar
PAUSE
  1. 作成したバッチファイルを実行します。そうすると、
  You need to agree to the EULA in order to run the server. Go to eula.txt for more info.

のようなメッセージが出てくるのでMinecraftサーバーを終了します。 6. 必ずEULA(MINECRAFT エンド ユーザー ライセンス条項)に同意してください． 7. 同意する場合、eula.txtを開いて

eula=false

を

eula=true

に書き換えて、保存してください。 8. 再度バッチファイルを実行すると、今度はきちんとサーバーが起動するはずです。 9. Minecraftのクライアントを起動し、マルチプレイヤーのダイレクト接続からアドレスにlocalhostと入力してください。 10. 接続できたならあなたの勝ちです。お疲れ様でした。 またサーバーを起動したくなったときには再度作成したbatファイルを実行して起動することができます。

開発チュートリアル

第一章 プラグインを動かす

開発環境が整ったら実際にプラグインをデバッグサーバーで動かしてみます。

レポジトリをcloneする

  1. GiganticMinecraft/SeichiAssistにアクセスしてください。
  2. clone or downloadと書かれたボタンを探してクリックしてください。 image alt GitHub Desktopを利用している場合
  3. GitHubにログインしていることを確認し、Open in Desktopを選択します。
  4. cloneを選択します。
  5. 下図のような画面になったら、cloneが成功している証拠です。お疲れ様でした。

外部Jarのダウンロード

詳細はGiganticMinecraft/SeichiAssistを参照してください。

プロジェクトの構成

  1. IDEAを起動します。
  2. Import Projectを選択します。
  3. Import project from external model -> Gradle -> Nextの順で選択します。
  4. 以下の項目にチェックを付けてFinishを選択します。
  5. Project Structure (Ctrl+Alt+Shift+Sを同時押し)を開きます。
  6. SDKで、JDKを設定します。
  7. インストールしたJDKディレクトリを選択します。
  8. Importが完了しました。お疲れ様でした。

Jarに詰めるお仕事

このままではただの変な拡張子がついたテキストファイルの集合なので、JDKに頑張ってもらってjarファイルにします。

  1. 右上のEdit Configurationsを選択します。
  2. 別ウィンドウが開くので+を押して、Gradleを選択します。
  3. Nameはわかり易い名前をつけてください。
  4. OKを押して閉じたあと、右上にある右三角を押すとJDKが頑張ってjarファイルにしてくれます。
  5. 完了です。お疲れ様でした。

第二章 開発

ブランチ、合流、分かれ道

本プロジェクトでは、developブランチから、実装している機能や対処している問題ごとにブランチを生やし、そこに対してコミットし、最終的にdevelopにPull Requestして合流するというフローになっています。

(編注: Gitの導入は本稿では取り扱いません。)

それでは新しいブランチの生やし方を。

  1. 右下にgit: developとあるはずなので、そこをクリックしてください。
  2. 一番上のcheckoutと書いてあるラベルをクリックしてください。
  3. ブランチに好きな名前をつけます。 (編注: 実際の例ではfeatureで始まることが多いです)
  4. 右下にgit: <入力された名前>と表示されていれば新しいブランスを生やすことができたという証拠です。お疲れ様でした。

コミット = セーブ

とはいえ、変更は「コミット」といった形で保存しないと(Git上では)永遠に無のままです。 そこで、コミットのやり方を説明します。

  1. 右上のチェックマーク(✓)を押します。
  2. 新しいウィンドウが出てくるので、Commit Messageに後で見てもわかりやすいメッセージを入力して、右下のCommitを押します。
  3. 左下にx files commitedとバルーンが出てきたらコミットができたという証拠です。お疲れ様でした。

プルリクエストで成果を反映

そして、機能追加や問題対処に一段落ついたと思ったら、Pull RequestをGitHubで送ります。 ですが、いまあなたがいるそのブランチは「ローカル」なもので、GitHubで「パブリック」になってはいません。つまり、一旦自分のレポジトリに反映させる必要があるのです。 そこで、Pull Requestを送るまでの手順を説明します。

  1. 上のメニューバーのCVSをクリックします。
  2. Git > Push (Ctrl + Shift+ Kの同時押し)を選択します。
  3. 新しいウィンドウが出るので、originとなっているところを自分のユーザーネームになおして、その後Pushしてください。
  4. Push successfullyとバルーンが下の方に出てきたら、プッシュが成功したという証拠です。お疲れ様でした。

参考

オリジナルの文書は整地鯖・アーカイブ を参照してください。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment