Cloth Config API — Minecraft の設定画面用 Mod

Cloth Config API — Minecraft の設定画面用 Mod

Cloth Config API は、数十もの Minecraft の Mod が、自身の設定をテキストファイルではなくゲーム内のメニューとして表示するために必要とするライブラリです。これ自体はゲームに何も追加しません。アイテムもブロックも新しい仕組みもありません。これは依存関係であり、これがなければ、それを利用する Mod は起動せず、Mod 一覧にエラーを表示します。

Mod が必要になるとき

このライブラリは単独でインストールするのではなく、ほかの Mod と一緒にインストールします。特定の modpack に必要かどうかは、2 つの方法で判断できます。

• Modrinth や CurseForge 上の Mod の説明で、Dependencies の一覧に Cloth Config API が記載されている。

• modpack を起動するとゲームが落ち、ログ（logs/latest.log）に cloth-config または cloth-config-2 が見つからないという記述が現れる。

内部名の cloth-config-2 はまったく同じ Mod を指します。これはライブラリの 2 つ目のメジャーバージョンから登場した識別子です。誰かが「cloth-config-2 が必要」と書いている場合、それは現行版の Cloth Config API のことです。

Mod の設定を開く方法

Forge と NeoForge では、インストール済みの Mod 一覧がゲームのメインメニューに組み込まれています。Mods という項目です。Cloth Config を組み込んだ各 Mod の隣には、設定アイコンが表示されます。クリックすると、まさにその Mod のすべての項目を備えた専用画面が開きます。

Fabric ではローダーに標準の Mod 一覧がないため、Cloth Config の画面へのアクセスはサードパーティの Mod 閲覧ツールを通じて実現されます。これはインストール済みのものの一覧を表示し、目的の項目の隣にあるボタンをクリックできるようにします。

Cloth Config を使った Mod の設定 

画面そのものの見た目

Mod のすべての画面は同じ構成で作られています。左側に項目のカテゴリ、中央に項目そのもの、下部に「保存」と「キャンセル」のボタンがあります。各項目は、その値の型に対応したインターフェース要素として表示されます。 

画面上部には、数十もの項目を持つ config 向けに検索フィールドがあります。これは一覧を名前で絞り込みます。Mod の作者が説明を設定した項目の隣では、カーソルを合わせると説明付きのツールチップが表示されます。

許容範囲外の値や不正な形式の値を入力すると、そのフィールドが強調表示され、エラーが修正されるまで保存ボタンは無効のままになります。各項目の隣にはリセットボタンがあり、値を Mod の作者がデフォルトとして指定したものに戻します。

まとめ

Cloth Config API はインフラ的な依存関係です。これがなければ一部の Mod はそもそも起動しませんが、Mod 自体はほかの組み込まれた Mod がなければゲーム内に目に見えるものを何ももたらしません。その役割は、十数種類のばらばらなインターフェースの代わりに、さまざまな Minecraft の Mod の設定を共通の視覚的な標準にまとめることです。Fabric やマルチプラットフォームの modpack では、Cloth Config API は依然として最も普及した共通の標準であり続けています。