简单数据修复

简单数据修复

一个库,使模组开发者能够注册自定义数据修复器。

基础库

easy data fix icon

Easy Data Fix

一个让模组开发者能够注册自定义数据修复器(data fixer)的库。

关于项目

Easy Data Fix 是一个小型库模组,用于帮助为模组创建数据修复器,使自定义的模组游戏数据能够安全地在不同游戏版本之间进行转换。该模组封装了内置的 DataFixerUpper 类,正如 Mojang 所说,它们是“一组用于数据转换的增量构建、合并和优化的实用工具”。

使用

  1. 从本 README 顶部列出的任一位置下载 easy_data_fix-<loader>-x.x.x+mc26.1。
  2. 将下载的 jar 文件复制到你的 mods 文件夹中。

在开发中使用该库

要为你的模组设置数据修复器,你首先需要在 build.gradle 文件中将该库添加为依赖项,然后在预启动(pre-launch)阶段使用 Easy Data Fix 的 API 注册它们。参见下面的示例。

build.gradle

repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
}

dependencies {
    ...

    // 将 <Tag> 替换为 Releases 页面中的发布标签字符串
    implementation "com.github.VoxelBill:easy-data-fix:<Tag>"
}

ExampleFix.java

public class ExampleFix implements PreLaunchEntrypoint {
    @Override
    public void onPreLaunch() {
        DataFixerRegistry.addDataFix("Description of data fixer", builder -> {
            // dataVersion = 你升级到的版本所使用的 Minecraft 数据版本。
            // SchemaVersion = 与该数据版本对应的内置 schema 类。
            // 示例:(4773, V4771::new) = 26.1 正式版
            Schema schema = builder.addSchema(dataVersion, V[SchemaVersion]::new);
            builder.addFixer(BlockRenameFix.create(schema, "Fixer Name", DataFixerAPI.createRenamer("example_mod:mod_block", "example_mod:new_mod_block")));
            builder.addFixer(ItemRenameFix.create(schema, "Fixer Name", DataFixerAPI.createRenamer("example_mod:mod_item", "example_mod:new_mod_item")));
        });
        // 你还可以在此处添加多个 DataFixerRegistry,以更好地组织你的数据修复或支持其他版本。
    }
}

开发入门

要获取本地副本并运行,请遵循以下简单步骤。

前置要求

确保你的机器上已安装以下内容:

  • Java 开发工具包(JDK):版本 25 或更高。
  • Gradle:版本 9.2 或更高。
  • Minecraft:版本 26.1

构建

  1. 克隆仓库
git clone https://github.com/VoxelBill/easy-data-fix.git
  1. 进入项目目录
cd easy-data-fix
  1. 使用 Gradle 构建项目
./gradlew clean build

你可以在 easy-data-fix/build/libs/easy_data_fix-<loader>-x.x.x+mc26.1.jar 找到构建好的模组。