Config API

Config API

带屏幕的锻造式配置API。

这是一个适用于 Fabric、Forge、NeoForge 和 Quilt 的配置 API。

它提供了一个配置屏幕,如果特定模组使用此配置系统,该屏幕将自动添加。


更新日志:

点击展开

配置 API 版本 2.5.0


  • 更新至 Minecraft 1.21.5
  • 更改了 ConfigRegister 的访问方式,现在是静态的,不再是单例
  • 添加了用于更改配置跟踪的字段
  • 修复了 ConfigTracker 尝试获取已更改路径的配置的问题,也包括那些不用于跟踪器的配置
  • 修复了可以注册多个同名配置的问题
  • 用带有 PlatformHelper 的自家系统替换了 ServicesLoader

配置 API 版本 2.4.1


  • 修复了不再尝试加载临时文件的问题
  • 更新至 Minecraft 1.21.4

配置 API 版本 2.4.0

--

  • 增加了对 1.21.2 和 1.21.3 的支持
  • 由于 Minecraft 的大量更改,移除了背景配置的支持
  • 更改了 registerConfig 方法中的参数顺序
  • 清理了代码并提升了性能
  • 重新设计了 ConfigTracking 以提高效率
  • 更改了“重置所有服务器配置”按钮的位置

配置 API 版本 2.3.2


  • 修复了打开屏幕时的崩溃问题
  • 添加了 HolderHelper,它是一个工具类

配置 API 版本 2.3.1


  • 添加了 SimpleResourceLocation,因为新的系统是不必要的

配置 API 版本 2.3.0


  • 为 Fabric 和 NeoForge 更新至 1.21

配置 API 版本 2.2.1


感谢 xLuPo 和 ornithoptercat

  • 从 quilt.mod.json 中移除了许可证,以防止崩溃
  • 重新添加了对 NeoForge 1.20.4 的支持
  • 修复了 Forge 在 1.20.4 上的崩溃问题,原因是 Logo
  • 修复了服务器兼容性问题,ServiceLoader 曾尝试在服务器上加载客户端方法

配置 API 版本 2.2.0

  • 目前,此模组不支持 Mod Menu
  • 你可以像这样在 fabric.mod.json 中为 Fabric 设置自定义背景,Quilt 也类似:
    • "custom": {
        "configapi": {
          "configBackground": "minecraft:textures/block/deepslate.png",
          "configListBackground": "minecraft:textures/block/stone.png"
        }
      }
      
  • 重新设计了 ListConfigScreen
    • 添加了“添加”菜单按钮
    • 添加了交换按钮
    • 一些技术性改动
  • 在左上角添加了每个模组的 ModLogo
  • 修复了列表 GUI 叠加层未渲染的视觉错误
  • 为 ListConfigs 添加了 getValueAtIndex 方法
  • 在 ConfigTypeSelectionScreen 中添加了配置类型标题
    • 添加了一个用于禁用的配置,默认值为 false(不显示)

配置 API 版本 2.1.0

#1.20.3+ 版本稍后推出

  • 添加了自定义背景(你可以为屏幕和列表设置自己的纹理)
    • 在 Forge & NeoForge 的 mods.toml 中
    • [modproperties.MOD_ID]
        configBackground=minecraft:textures/block/bedrock.png
        configListBackground=minecraft:textures/block/stone.png
      
  • 让 AddSpaceAfterCapitalLetter 更加智能
  • 重新设计了屏幕导航按钮,现在你可以在所有配置屏幕之间导航
    • 移除了副标题

配置 API 版本 2.0.0

  • 使 ConfigTracker 更加高效
    • 添加了一个方法用于停止被跟踪的配置
  • 为类型为 SERVER 的配置添加了服务器支持
    • 这些配置仅在服务器上加载
    • 服务器配置保存在世界的文件夹内
      • 这允许你仅在特定世界中设置某些内容
  • 添加了 ConfigWorldSelectionScreen
    • 如果你想打开服务器配置,但不在世界内,你可以选择要修改哪个配置
    • 如果你在世界内,你可以直接修改它
  • 为配置屏幕添加了一个示例配置
  • 修复了 quilt mixin

配置 API 版本 1.2.0

  • 添加了复选框按钮
  • 添加了深度搜索
  • 如果你在一个文件夹内,然后启用它,所有该文件夹内及其后的配置都会被显示
  • 现在你需要输入 '#' 来搜索工具提示
  • 为搜索框添加了新机制
    • 搜索建议
    • 现在会用一个搜索放大镜显示
    • 如果你搜索了某些内容,可以点击删除按钮
  • 修复了客户端配置在 Fabric 上不被跟踪的问题
  • 优化了加载和跟踪方法
  • 重写了 ConfigFileWriter 以提高性能
  • 优化了其他一些内容

配置 API 版本 1.1.1

  • 修复了服务器兼容性
  • 添加了 ConfigEditBox 以获得更友好的可用性
    • 现在你可以按 Enter 键退出编辑框/搜索框
    • 以及其他一些内容
  • 修复了枚举和列表屏幕的重置按钮未正确设置的问题

配置 API 版本 1.1.0

#重大更改:新的文件格式是 .cfg,目录已移动,现在与 v1.0.0 不兼容

  • 添加了导航按钮
  • 显示的配置名称现在在大写字母后有一个空格
  • 修复了重置按钮,不会重置所有配置
  • 移除了配置屏幕中的“重置所有”按钮
  • 重新设计了配置类型选择屏幕
    • 为特定配置类型添加了图标
    • 添加了重置按钮,用于重置文件
    • 添加了“打开配置文件”按钮
  • 添加了搜索框作为额外的小部件
  • 添加了图像文本按钮作为额外的小部件
  • 添加了用于 getConfigDirectory、isModLoaded 和 getEnvironment 的服务

配置 API 版本 1.0.0

  • 支持的模组加载器:Fabric、Forge、NeoForge 和 Quilt
  • Fabric 需要 Fabric API
  • 配置屏幕功能:
    • 自动添加
    • 按类别组织
    • 目前仅适用于 Forge 和 NeoForge
  • 仅当你在特定环境中时,配置文件才会被保存和跟踪
    • 通用配置始终被跟踪并直接加载,它们是最安全的使用选项
  • 使用说明,请参考 GitHub 上的 README.md 文件
    • 由于需要密码密钥,目前无法访问