User Tools

Site Tools


zh_cn:tutorial:datagen_setup

This is an old revision of the document!


数据生成入门

数据生成是 Fabric API 中的新模块,允许动态生成配方、语言文件、战利品表、进度以及几乎所有带有自定义 provider 的一切。

首先我们添加一个新的 Gradle 任务,运行我们用来生成数据的代码,从而让 Minecraft 能够读都这些数据。每次你修改生成进度的代码(或其他数据生成可以生成的内容,如战利品表)你都需要运行 Gradle 任务 runDatagenClient。我们后面会做这个,但先打开你的 build.gradle 文件并添加以下的任务:

loom {
    runs {
        // 添加一个新的 gradle 任务,会运行数据生成 API:“gradlew runDatagenClient”
        datagenClient {
            inherit client
            name "Data Generation"
            vmArg "-Dfabric-api.datagen"
            vmArg "-Dfabric-api.datagen.output-dir=${file("src/main/generated")}"
            vmArg "-Dfabric-api.datagen.strict-validation"
 
            runDir "build/datagen"
        }
    }
}
 
// 将数据生成的文件添加到 jar 中。
sourceSets {
    main {
        resources {
            srcDirs += [
                    'src/main/generated'
            ]
        }
    }
}

你可能注意到了,这里使用了变量 ${modid},这应该在 gradle.properties 文件中定义。检查其中是否存在,如果没有,你可以添加,就像这样:

// .. (文件的剩余部分)
 
modid=你的模组的id
 
// .. (文件的剩余部分)

然后,在项目中定义一个新的类 DataGeneration 并实现 DataGeneratorEntrypoint,并添加到你的 fabric.mod.json 中:

  • 其中的 onInitializeDataGenerator 方法会在我们前面创建的 Gradle 任务运行时调用。
import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;
import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
 
public class DataGeneration implements DataGeneratorEntrypoint {
 
    @Override
    public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
 
    }
}

然后我们需要在 fabric.mod.json 文件中,告诉 Fabric 这个入口点:

{
 
  // ...(文件和剩余部分)
 
  "entrypoints": {
    "fabric-datagen": [
      "DataGeneration"
    ],
    "main": [
      "AdvancementsTutorial"
    ],
    "client": [
      "AdvancementsTutorialClient"
    ]
  },
 
  // ...(文件的剩余部分)
 
}

我们先看看我们现在已经有的内容是否正常第一次,或者是否有任何的错误,确认无误后继续。运行 runDatagenClient 任务。你可以让 IDE 为你做这个,或者只需要在你的项目的根目录中打开终端并输入:

./gradlew runDatagenClient

看看结果并确认没有错误。

  • 你可以忽略:com.mojang.authlib.exceptions.InvalidCredentialsException: Status: 401,如果出现了的话。这个错误是因为我们正在运行的 Minecraft 的调试版本不会验证我们的账户。

如果你遇到错误,那么缺少或者错误的东西应该会非常清楚,但如果你无法查明,你可能需要前往 Discord 或 QQ 群中寻求帮助。

src/main 中应该会有个叫做 generated 的新文件夹。目前它会是空的,但我们生成数据(例如进度)之后,这些文件就会被保存。

添加提供器

这里有一些概述,讲述如何添加提供器,关于每个提供器更加详细的信息,请阅读以下几个页面:

在这个例子中,我们会创建一个标签提供器,因为最容易理解。

首先,在你的 DataGeneration 类中,创建新的 private static class 并继承 FabricTagProvider<T>

如有需要,可以把这个类放到单独的文件中,不过我们建议放在数据生成入口点类中。

private static class MyTagGenerator extends FabricTagProvider<Item> {
        public MyTagGenerator(FabricDataGenerator dataGenerator) {
            super(dataGenerator, Registries.ITEM);  // 1.19.2 之前的版本用 Registry.ITEM
        }
 
        @Override
        protected void generateTags() {
 
        }
}

作为示例,我们会在 generateTags() 中添加一些基本的标签:

// 创建名为“smelly_items”的物品标签。
private static final TagKey<Item> SMELLY_ITEMS = TagKey.of(RegistryKeys.ITEM, new Identifier("tutorial", "smelly_items"));
 
@Override
protected void generateTags() {
     // 创建一个 tag builder,我们添加粘液球、腐肉以及物品标签 minecraft:dirt 中的所有内容。
     getOrCreateTagBuilder(SMELLY_ITEMS)
              .add(Items.SLIME_BALL)
              .add(Items.ROTTEN_FLESH)
              .addOptionalTag(ItemTags.DIRT);
     // 在“generated”文件夹中,会自动生成“assets/tutorial/tags/items/smelly_items.json”。
}

现在,我们需要在你的入口点类的 onInitializeDataGenerator 中的数据生成器中,注册这个提供器。

public class DataGeneration implements DataGeneratorEntrypoint {
    @Override
    public void onInitializeDataGenerator(FabricDataGenerator fabricDataGenerator) {
        fabricDataGenerator.addProvider(MyTagGenerator::new);
    }
}

当我们运行 gradlew runDatagenClient,我们将会看到生成的文件形式,物品标签 json 应该存在:

smelly_items.json
{
  "replace": false,
  "values": [
    "minecraft:slime_ball",
    "minecraft:rotten_flesh",
    {
      "id": "#minecraft:dirt",
      "required": false
    }
  ]
}
zh_cn/tutorial/datagen_setup.1683197381.txt.gz · Last modified: 2023/05/04 10:49 by solidblock