Lexiconfig

Lexiconfig

这是一个配置API,旨在与其它库一起提供多种集成,并尽可能易于使用,无论对开发者还是用户都是如此。

概述

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

它具有简单易用的基于注解的语法,使创建新的配置文件尽可能简单。

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

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

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

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

状态 模组
❌ Cloth Config
❌ oωo config
✅ Configured
❌ Forge Config Screens

开发

此模组包含一个 API,可用于存放新的 lexicon、监听事件等。

依赖

build.gradle

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

你可以前往 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 = MY_LEXICON_TITLE) // preferably use your mod id as a name
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,这可以通过简单地将其实例作为 library 中的字段添加,并在给定的方法中存放它来完成。

@LexiconLibrary
public class MyNewLibrary extends Library {
  public static MyLexicon MY_LEXICON = new MyLexicon();

  @Override
  public void shelveLexicons() {
    LexiconfigApi.shelveLexicon(MY_LEXICON);
  }
}