Minecraft 1.20.1, 1.21.1用Lexiconfig MOD

概要

これは、複数の異なるコンフィグライブラリ間の互換性を提供し、マルチローダープロジェクト構成でも使いやすいようにするためのコンフィグAPIで、主に私のModで使用することを目的としています。

使いやすいアノテーションベースの構文を備えており、新しい設定ファイルをできるだけ簡単に作成できます。

あなたがModユーザーなら、この情報はおそらくあまり役に立ちません。しかし、あなたがMod開発者で、自分のプロジェクトでLexiconfigを使いたい場合は、さらに下の開発のセクションまでスクロールしてください。

現在、他のコンフィグライブラリのサポートはありませんが、更新を続けるにつれて、それぞれの互換性を追加し、他と競合せず、シームレスに統合できるようにしていきます。

以下は、さまざまなコンフィグライブラリ/API間での現在および予定されている統合の一覧です:

❌ - 未統合 ✅ - 統合済み ❓ - 進行中

ステータス Mod

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

開発

このModには、新しいレキシコンを保管したり、イベントをリッスンしたりするために使用できるAPIが含まれています。

依存関係

build.gradle

dependencies { implementation "com.codinglitch.lexiconfig:lexiconfig-api:APIVERSIONHERE" }

最新のAPIバージョンを確認するには https://versions.codinglitch.com にアクセスしてください。

使用方法

独自のレキシコンを保管するには、まず独自のLibraryを作成する必要があります。これは、Libraryクラスを継承した新しいクラスを作成し、LexiconLibraryアノテーションを付けるだけで行えます。

@LexiconLibrary public class MyNewLibrary extends Library { @Override public void shelveLexicons() { } }

Forgeの構成では、それ以上の変更は必要ありません。ただし、Fabric向けに開発している場合は、このクラスをfabric.mod.jsonのエントリポイントとして追加する必要があります。

fabric.mod.json

//... "entrypoints": { "lexiconfig": [ "com.path.to.MyNewLibrary" ] } //...

次のステップは、いよいよレキシコンを作成して保管することです。これは、レキシコン用に別のクラスを作成し、次のように適切なアノテーションを付けるだけで行えます:

@Lexicon(name = MYLEXICONTITLE) // 名前にはできればあなたのMod IDを使用してください public class MyLexicon extends LexiconData { @LexiconEntry(comment = "これはシンプルなフィールドへのコメントです!") public String mySimpleField = "content"; @LexiconPage(comment = "これは新しいカテゴリへの素敵な新しいコメントです!") public MyNewPage myNewPage = new MyNewPage(); public static class MyNewPage extends LexiconPageData { @LexiconEntry(comment = "このフィールドはレキシコンページの中にあります!") public Boolean myPageField = true; } }

次で最後のステップは、レキシコンを保管することです。これは、そのインスタンスをライブラリ内のフィールドとして追加し、指定されたメソッドで保管するだけで行えます。

@LexiconLibrary public class MyNewLibrary extends Library { public static MyLexicon MYLEXICON = new MyLexicon(); @Override public void shelveLexicons() { LexiconfigApi.shelveLexicon(MYLEXICON); } }