Forge Config API Port — Minecraft Java Edition

バニラのMinecraftにはゲームやModの設定を簡単に管理する機能が組み込まれていないため、開発者は設定保存システムを独自に作成する必要があります。ModローダーのForgeは独自の設定システムによる完成されたソリューションを提供していますが、Fabricには歴史的に統一された標準がありませんでした。そのため、クロスプラットフォームModの作成者はローダーごとに個別の設定コードを記述しなければならず、多くの時間を費やしています。Forge Config API Portライブラリは、Forgeの長年の実績がある設定インターフェースをFabricやQuiltに移植することでこの問題を解決します。

ライブラリの仕組み

Forge Config API Portは、Modのコードとゲームのファイルシステムの仲介役として機能します。Fabric環境内で元のnet.minecraftforge.common.ForgeConfigSpecおよびnet.neoforged.fml.configパッケージを完全に再現します。開発者は標準のForge構文を使用して設定の記述を1回書くだけでよく、ライブラリが自動的にディスク上に適切なファイルを作成し、その読み込みを管理します。

TOML設定ファイルの形式

ライブラリはすべての設定をTOML形式で保存します。この形式は、通常のテキストエディタを使用して読み取りおよび編集するのに便利な構造を提供します。各パラメータには、コメント、デフォルト値、さらに許容される値の明確な制限（最小値および最大値）を含めることができます。設定ファイルは、Modを初めて起動したときにゲームのルートディレクトリ内にあるconfigフォルダに自動的に表示されます。これらは.toml拡張子を持ち、Modの開発者が指定した名前が付けられます。

自動同期と動的再読み込み

Forge Config API Portの最も重要な機能の1つは、設定の同期と動的再読み込みの組み込みサポートです:

• サーバーとクライアント間の同期 (Sync): プレイヤーがサーバーに接続すると、サーバーは自動的に設定をクライアントに送信します。これにより、サーバー上のプレイヤー間で設定バージョンの違いによる競合が発生するのを防ぎます。

• 動的再読み込み (Reload): ライブラリはTOMLファイルへの変更をリアルタイムで追跡します。ゲーム中に設定ファイルを編集して保存すると、Forge Config API PortはMinecraftクライアントを再起動することなく、メモリ内のパラメータを直ちに更新します。

これらのメカニズムは自動的に機能し、開発者が設定値の同期のためのネットワーク通信を自分でコード化する必要性を排除します。

プレイヤーと開発者にとっての意義

一般のプレイヤーにとって、Forge Config API Portは目に見えるコンテンツ、新しいブロック、またはアイテムを追加しません。その役割は、他のModが機能することを保証することです。他のModがこのライブラリのクラスを参照している場合、このライブラリをインストールしないとゲームは起動しません。ForgeとNeoForgeはこれらの機能を構造上デフォルトで備えているため、このModは主にFabricユーザーに必要とされます。

開発者にとって、このライブラリはクロスプラットフォームプロジェクトを作成する際に不可欠なツールです。これにより、以下のことが可能になります:

1. 以前は異なるローダー用に個別の設定保存ロジックを開発するために費やされていた何百行ものコードを節約できます。

2. 設定ファイルがFabricとForgeで同一の構造を持つため、エンドユーザーにMod管理の同じエクスペリエンスを提供できます。

3. Forgeの強力な値検証ツールを使用して、ユーザーによる誤った入力を自動的に修正し、クラッシュ時にパラメータをデフォルト値に戻すことができます。

人気のある前提とするMod

Fuzs (またはFuzs_) という名前で知られるライブラリの開発者は、彼の人気のModすべてにこれを使用しています。有名な例をいくつか紹介します:

• Easy Magic: エンチャントテーブルのメカニズムを変更し、テーブルのインベントリにアイテムを保持できるようにし、エンチャントを強化する新しい方法を追加するMod。

• Trading Post: 周囲にいるすべての村人の取引のオファーを単一のインターフェースでまとめるブロック。

• Visuality: さまざまなモブのアクションからリアルな土の粒子、火花、水しぶきを追加する視覚効果Mod。

• Easy Shulker Boxes: シュルカーボックスを地面に置くことなく、インベントリから直接操作できるようにします。

Fuzsのプロジェクトに加えて、何百人もの他の開発者がForge Config API Portを使用して作業をForgeからFabricに移植しており、プレイヤーは高品質なコンテンツの膨大なライブラリにアクセスできるようになっています。