Mcmod.infoの設定

はじめに

mcmod.infoとは、MODの情報を記載するファイルで、JSON形式で書く。 一部の情報は、@Modアノテーションの付いたクラスで記述することが出来る。 ここでは、FMLのGithub wiki内のmod information fileを元に日本語で解説する。

mcmod.infoファイルの例

単体MODの場合

[
{
    "modinfoversion": 2,
    "modid": "yourmodid",
    "name": "yourmodname",
    "description": "yourmoddescriprion",
    "version": "yourmodversion",
    "mcversion": "supportmcversion",
    "url": "yourownwebsiteurl",
    "updateUrl": "updatecheckurl",
    "authorList": ["author1","author2"],
    "credits": "credits",
    "logoFile": "logofile",
    "screenshots": ["screenshots"],
    "requiredMods": ["Forge","otherapi"],
    "dependencies": ["api"],
    "useDependencyInformation": true
}
]

複数MODの情報を一度に記載したい場合

解説元の例をそのまま載せる。

{
  "modListVersion": 2,
  "modList": [{
    "modid": "mod_IronChest",
    "name": "Iron Chest",
    "description": "A simple mod adding some new chests with larger sizes, upgradeable in place. The feature chest is the crystal chest, which is see-through - this inventory contents can be viewed without opening the chest.",
    "version": "3.1.1.21",
    "mcversion": "1.4.5",
    "url": "http://www.minecraftforum.net/topic/981855-",
    "updateUrl": "",
    "authorList": [ "cpw", "Lishid" ],
    "credits": "Authored by cpw, based on an original idea by Lishid",
    "logoFile": "/mod_IronChest.logo.png",
    "screenshots": [ "shot1.png", "shot2.png" ],
    "parent": "mod_BuildCraftCore",
    "requiredMods": [ "Forge", "mod_BuildCraftCore" ],
    "dependencies": [ "mod_BuildCraftCore" ],
    "dependants": [ "MySpecialSubMod" ],
    "useDependencyInformation": true
  }]
}

解説

属性値表

属性値	型	説明
modid	文字列	MOD固有の文字列、存在しないmodidの場合は無視される
name	文字列	MODの名前
description	文字列	MODの説明
version	文字列	MODのバージョン
mcversion	文字列	対応しているMinecraftのバージョン
url	文字列	MODの公開されているサイトのURL
updateUrl	文字列	アップデート用URL。将来用で現在はまだ意味が無い
authorList	文字列配列	MODの開発者
credits	文字列	開発者以外に記載すべき人物等ある場合
logoFile	文字列	起動時のmodsリストで表示されるロゴのjar(zip)内でのパス文字列
screenshots	文字列配列	MODのスクリーンショット。将来用で現在はまだ意味が無い
parent	文字列	モジュールタイプのMODの親のMODのmodidを指定。起動時のmodsリストで親の項目にまとめられる。
requiredMods	文字列配列	MODの前提MODのmodid配列。記載したMODが入ってない場合、エラーを出す。
dependencies	文字列配列	先に読み込まれて欲しいMODのmodid配列。ここに記載されているMODがはいっていなくてもエラーは出ない。
dependants	文字列配列	このMODのあとに読み込まれて欲しいMODのmodid配列。
useDependencyInformation	真偽値	falseの場合、上記の３つの属性値は無視される。

mcmod.infoの配置場所

mcmod.infoはjar(zip)のディレクトリ直下に置く。
sample.jar
|-package1
|-assets
|-mcmod.info