Posted at

Slay the Spire Mod開発入門(2) 開発環境構築編


はじめに

本章では自分自身でModのjarを作成する方法について、あらかじめ作成したサンプルを使って説明していきます。


Modのjarが満たすべき要件

Modのjarは以下のファイル群を含んでいる必要があります


  • Modの名前やバージョンや作者情報を表す ModTheSpire.json ファイル


  • @SpireInitializerMod アノテーションで修飾されたModのエントリポイントクラスファイル

  • カードやレリック等を表すクラスファイル

  • 画像や音声, 言語ファイルを表す resourceファイル群

具体的には以下のような構成となります。

ModTheSpire.json

com/qiita/ykojim/Main.class
com/qiita/ykojim/MyCard1.class
com/qiita/ykojim/MyCard2.class
assets/img/card1.png
assets/img/card2.png
assets/loc/CardStrings.json


ビルド環境の作成とビルドの実行

前述の要件さえ満たせればjarはどのように作成しても構わないのですが、ここではJDKとmvnwを使用することとします。


  • JDKをインストール

  • Githubの https://github.com/kojim/StSModStudy リポジトリをclone

  • SteamのSlay the Spireディレクトリ(デフォルトはC:\Program Files (x86)\Steam\steamapps\common\SlayTheSpire)から desktop-1.0.jar をclone先のlibディレクトリにコピー


  • mod001 ディレクトリにて mvnw.cmd package を実行

これにより clone先ディレクトリのtargetサブディレクトリにStsModStudy.jarが作成されます。