【Minecrft Modding】ParchmentMCでライブラリを変数名とJavaDocがちゃんとしたものに変える
ParchmentMCとは
Minecraft Modding
はまだまだ人気のないコンテンツで情報も非常に限られています。公式リファレンスも数多の解説サイトもそれぞれで言っていることが異なってたり、そもそもどんなメソッドがあるのかすらわかりませんよね。そんな時、やはり信用できるのは元のスーパークラスのソースです。Intellij IDEA
で開発している方はAlt+左クリック
で参照できます。
ですが、肝心のソースは変数名がp_<五桁の整数>
になっていたり、JavaDoc
がインターフェイスにしかなかったり...。ParchmentMC
は変数名を意味の通るものに変え、JavaDoc
を充実させるプラグインです。言語は英語ですが書いていないよりは圧倒的に有益です。
実は、ParchmentMC
は公式がbuild.gradle
ファイル内でコメントで言及しています。
The mappings can be changed at any time and must be in the following format.
Channel: Version:
official MCVersion Official field/method names from Mojang mapping files
parchment YYYY.MM.DD-MCVersion Open community-sourced parameter names and javadocs layered on top of officialYou must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.mdParchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
Additional setup is needed to use their mappings: https://github.com/ParchmentMC/Parchment/wiki/Getting-Started
じゃあ公式がもっと宣伝しろし!
と思いますが。
導入
導入の手順は簡単です。下の公式記事で説明されています。
settings.gradle
pluginManagement {
repositories {
gradlePluginPortal()
maven { url = 'https://maven.minecraftforge.net/' }
+ maven { url = 'https://maven.parchmentmc.org' }
}
}
build.gradle
plugins {
// 中略
id 'net.minecraftforge.gradle' version '5.1.+'
+ id 'org.parchmentmc.librarian.forgegradle' version '1.+'
}
// 中略
minecraft {
// 中略
- mappings channel: 'official', version: '1.19.2'
+ mappings channel: 'parchment', version: '2022.08.14-1.19.2'
// 後略
version: '2022.08.14-1.19.2'
については上の公式記事に記載がありますので使用したいバージョンの番号を参照してください。
これで更新すれば終了です。あら簡単。
使い方
Intellij IDEA
では見たいクラスにAlt+左クリック
すれば参照できます。また、入力補完機能でちゃんとした変数になります。
最後に
これで地獄の分析作業から解放されるぞ!!!!
こちらのBookにて、Modding
と闘っておりますのでぜひ。
Discussion