Fabric.mod.jsonの設定

この記事は"Fabric API 0.3.2 build 230～"を前提MODとしています。

はじめに

fabric.mod.jsonとは、Fabric LoaderがMODを読み込むために使用する情報を記載するファイルである。 Mod Menuで情報を表示するためのファイルでもある。

• 英公式Wiki

fabric.mod.jsonファイルの例

単体MODの場合

{
  "schemaVersion": 1,
  "id": "modid",
  "version": "${version}",

  "name": "Example Mod",
  "description": "This is an example description! Tell everyone what your mod is about!",
  "authors": [
    "Me!"
  ],
  "contact": {
    "homepage": "https://fabricmc.net/",
    "sources": "https://github.com/FabricMC/fabric-example-mod"
  },

  "license": "CC0-1.0",
  "icon": "assets/modid/icon.png",

  "environment": "*",
  "entrypoints": {
    "main": [
      "net.fabricmc.example.ExampleMod"
    ]
  },
  "mixins": [
    "modid.mixins.json"
  ],

  "depends": {
    "fabricloader": ">=0.4.0",
    "fabric": "*"
  },
  "suggests": {
    "flamingo": "*"
  }
}

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

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

{
  "schemaVersion": 1,
  "id": "fabric",
  "name": "Fabric API",
  "version": "0.3.2+build.219-1.15",
  "description": "Core API module providing key hooks and intercompatibility features.",
  "license": "Apache-2.0",
  "icon": "assets/fabric/icon.png",
  "contact": {
    "homepage": "https://fabricmc.net",
    "irc": "irc://irc.esper.net:6667/fabric",
    "issues": "https://github.com/FabricMC/fabric/issues",
    "sources": "https://github.com/FabricMC/fabric"
  },
  "depends": {
    "fabricloader": "\u003e\u003d0.6.1",
    "minecraft": "1.15.x"
  },
  "jars": [
    {
      "file": "META-INF/jars/fabric-api-base-0.1.0+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-biomes-v1-0.1.1+413f3d6046.jar"
    },
    {
      "file": "META-INF/jars/fabric-commands-v0-0.1.1+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-containers-v0-0.1.2+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-content-registries-v0-0.1.1+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-crash-report-info-v1-0.1.1+9f55aa7046.jar"
    },
    {
      "file": "META-INF/jars/fabric-events-interaction-v0-0.1.2+27da48aa46.jar"
    },
    {
      "file": "META-INF/jars/fabric-events-lifecycle-v0-0.1.1+eff46b3d46.jar"
    },
    {
      "file": "META-INF/jars/fabric-item-groups-v0-0.1.1+66a6b61046.jar"
    },
    {
      "file": "META-INF/jars/fabric-keybindings-v0-0.1.1+7dfef87c46.jar"
    },
    {
      "file": "META-INF/jars/fabric-loot-tables-v1-0.1.0+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-mining-levels-v0-0.1.0+ab421b9c46.jar"
    },
    {
      "file": "META-INF/jars/fabric-models-v0-0.1.0+5914746346.jar"
    },
    {
      "file": "META-INF/jars/fabric-networking-blockentity-v0-0.1.1+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-networking-v0-0.1.3+9f55aa7046.jar"
    },
    {
      "file": "META-INF/jars/fabric-object-builders-0.1.1+9b03381f46.jar"
    },
    {
      "file": "META-INF/jars/fabric-registry-sync-v0-0.2.2+9b03381f46.jar"
    },
    {
      "file": "META-INF/jars/fabric-renderer-api-v1-0.1.1+9b03381f46.jar"
    },
    {
      "file": "META-INF/jars/fabric-renderer-indigo-0.1.13+b4f62fb546.jar"
    },
    {
      "file": "META-INF/jars/fabric-rendering-data-attachment-v1-0.1.0+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-rendering-fluids-v1-0.1.1+39442fc246.jar"
    },
    {
      "file": "META-INF/jars/fabric-rendering-v0-0.1.2+413f3d6046.jar"
    },
    {
      "file": "META-INF/jars/fabric-resource-loader-v0-0.1.3+d1f89c1d46.jar"
    },
    {
      "file": "META-INF/jars/fabric-tag-extensions-v0-0.1.1+b494ebeb46.jar"
    },
    {
      "file": "META-INF/jars/fabric-textures-v0-0.1.4+b494ebeb46.jar"
    }
  ]
}

解説

属性値表

属性値	型	説明
id	文字列	MOD固有の文字列、存在しないmodidの場合は無視される
version	文字列	MODのバージョン、${version}は、gradle.propertiesで設定された文字列となる。
name	文字列	MODの名前
description	文字列	MODの説明
authors	文字列	MODの開発者、メンバー
contact	文字列	MODの公開されているサイトのURL
homepage	文字列	MODの公開されているサイトのURL
sources	文字列	MODのソースが公開されているサイトのURL
license	文字列	MODのライセンス、編集しなくてもよい。ライセンス情報を定義する。単一のライセンス文字列、またはそれらのリストのいずれか。
icon	文字列	Mod MenuのMODリストで表示されるアイコンのjar(zip)内でのパス文字列。アイコンは正方形のPNGファイル
environment	文字列	*
entrypoints	文字列	main
main	文字列	MODのメインのクラスのパスを指定
mixins	文字列	（MODID）.mixins.json
depends	文字列	fabricloader、fabric
fabricloader	文字列	FabricLoaderの
email	メールアドレス	email

fabric.mod.jsonの配置場所

fabric.mod.jsonはjar(zip)のディレクトリ直下に置く。
sample.jar
|-package1
|-assets
|-data（有無）
|-fabric.mod.json