适用于 Minecraft 1.20.1, 1.21.1 的 Lexiconfig 模组

概述

这是一个配置 API，旨在提供与多个其他配置库的兼容性，并且在多加载器项目设置中易于使用，主要用于我的模组。

它采用简单易用的基于注解的语法，尽可能简化新配置文件的创建。

如果你是模组用户，这些信息可能对你没什么用。但如果你是模组开发者，并且希望在自己的项目中使用 Lexiconfig，请继续向下滚动到开发部分。

它目前尚不支持其他配置库，但随着我持续更新，我会为每一个添加更多兼容性，以确保它不会与其他库冲突，而是能够在它们之间无缝集成。

以下是当前以及计划中跨不同配置库/API 的集成列表：

❌ - 未集成 ✅ - 已集成 ❓ - 进行中

状态 模组

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

开发

此模组包含一个 API，可用于注册新的 lexicon、监听事件等。

依赖

build.gradle

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

你可以前往 https://versions.codinglitch.com 查看最新的 API 版本。

用法

要注册你自己的 lexicon，你首先需要创建自己的 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。你可以通过简单地为 lexicon 创建另一个类，并为其提供适当的注解来完成，如下所示：

@Lexicon(name = MYLEXICONTITLE) // 最好使用你的模组 ID 作为名称 public class MyLexicon extends LexiconData { @LexiconEntry(comment = "This is a comment for a simple field!") public String mySimpleField = "content"; @LexiconPage(comment = "This is a fancy new comment on the fancy new category!") public MyNewPage myNewPage = new MyNewPage(); public static class MyNewPage extends LexiconPageData { @LexiconEntry(comment = "This field is inside a lexicon page!") public Boolean myPageField = true; } }

下一步也是最后一步是注册该 lexicon，这可以通过简单地将其实例作为库中的字段添加，并在给定的方法中注册它来完成。

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