Lexiconfig

模组

· 作者 CodinGlitch

这是一个配置 API,旨在与其他库一起提供多种集成,并且尽可能易于使用,无论是开发者还是用户都能轻松上手。

14 本站下载 0 关注 更新于 3 周前

需要前置:Fabric API

最新 1.4.22-novel · 1.21.11 · Fabric

一键开服(送7天)

概览

这是一个配置 API,旨在为多种不同的配置库提供兼容性,并便于在多加载器项目设置中使用,主要供我的模组使用。

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

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

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

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

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

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

开发

本模组包含一个 API,可用于归档新的 lexicons、监听事件等。

依赖

build.gradle

repositories {
  maven { url 'https://maven.codinglitch.com/repository/releases' }
}

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

你可以访问 查看最新的 API 版本。

用法

要归档你自己的 lexicons,首先必须创建一个自己的 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"
  ]
}
//...

下一步是最终创建并归档你的 lexicons。你可以通过为 lexicon 创建另一个类并提供适当的注解来实现,如下所示:

@Lexicon(name = MY_LEXICON_TITLE) // 建议使用你的模组 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 = "此字段位于 lexicon 页面内!")
    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);
  }
}

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源