Click here for English version of this document.
BRRP（Better Runtime Resource Pack，更好的运行时资源包），是可用于在运行时创建游戏资源的前置模组，同时是 ARRP（高级运行时资源包）模组的一个分支。
欢迎加入QQ群 587928350 体验本模组的最新更新。
注意：自版本 1.0.0 开始，本模组的 ID 由 better_runtime_resource_pack 更改为 brrp_v1，并进行大量重构，不向下兼容，但可以于旧版本共存。如非需要，请不要再使用旧版本的 BRRP 模组。
作者对此模组的性能进行了测试，对于模组的内置资源包，采用了以下三种方式测试启动：
- 使用运行时资源包的旧实现（模组版本 1.1.0 之前），即：运行时将资源生成为字节形式存储在内存中，然后从内存中读取字节形式。
- 使用运行时资源包的新实现（自模组版本 1.1.0 开始），即：运行时资源生成为 Java 中的对象的形式，然后从内存中直接读取这些对象，减少序列化和反序列化的过程。
- 不使用运行时资源包，即：将资源存储在模组文件中。
经测试，上述三种实现方式的性能差异不大。这也就意味着，对目前版本而言，运行时资源包并没有起到性能提升的效果。而模组本身因涉及复杂的修改，难免存在兼容性和维护难度的问题。因此作者的其他模组，未来将不再依赖此模组。实际上，Fabric API 自带的 Fabric Data Generation API 兼容性更好，且也在更新与维护，不需要消耗我自己的精力，所以更值得使用。
但是，运行时资源包能显著减少模组文件的大小，并且有可能是动态的，目前仍有部分模组依赖了本模组。因此对于未来的 Minecraft 版本，本模组仍会更新，并接受在 GitHub 中反馈问题。
运行时资源包是在运行时创建的 Minecraft 资源文件，从而避免一些重复的操作。对于存在大量相似方块和物品的模组而言，借助运行时资源包可以极大地减小模组文件的大小。
例如，绝大多数方块的战利品表可以描述为“掉落方块本身”，少数方块需要精准采集才会掉落，而对于台阶方块，破坏双台阶后会掉落两倍的方块。在战利品表中，每个方块都要单独定义一个战利品表 JSON 文件，这是显然非常费神的。又如，几乎每个方块都需要定义方块状态、方块模型和物品模型，其中方块模型可能还不止一个，如果再加上战利品表和配方（若有）的话，每个方块都需要至少 5 个 JSON 文件才能实现完整的功能。而运行时资源包则会让这些内容在运行时生成在游戏内部，不需要打包在模组 JAR 文件中。
运行时资源包和常规的资源包在功能上一致的，常规的资源包（无论是模组自带资源包还是手动安装的资源包或数据包）都可以覆盖运行时资源包内容，亦可以与运行时资源包相互牵连。一个很典型的例子是，方块的模型由运行时资源包定义，而其纹理则是以传统的方式存储在模组文件中的（因为纹理文件并不适合在运行时生成）。
与传统资源包相比，运行时资源包节省了输入输出（I/O）。资源包在生成时，会由游戏内对象转化为字节形式，通常是输出为 JSON，这一过程称为序列化。游戏在读取资源包时，又会重新解析这些字节形式的内容，以产生游戏内的对象，这一过程称为反序列化。传统的资源包中，所有的资源是已经序列化了的，游戏在加载资源包时只需要进行反序列化即可。而运行时资源包内的运行时资源有以下几种：
- 存储为字节形式。这是最原始也是最兼容的形式，本模组的旧版本都是使用的这种形式，但是在生成资源时，需要将 Java 中的对象序列化为字节形式，在加载资源包时由字节形式转化为 Java 中的对象，这可能会耗费性能。
- 存储为 JSON 形式，本模组中的方块状态和方块模型就是以这种方式存储的。生成资源时，需要将 Java 中的对象序列化为 JSON，但是不需要再将 JSON 序列化为字节形式。加载资源包时，就可以从 JSON 形式进行反序列化。
- 直接存储为 Java 对象，本模组中的战利品表、标签、进度、配方等就是以这种存在的。生成资源时，直接将 Java 中的对象存储在运行时资源包中，加载资源包时直接读取这些 Java 对象就可以了。
这里梳理一遍传统资源包和运行时资源包在游戏内的读取过程：
- 传统的资源包
- JSON 形式文件（如战利品表、模型）：
- 读取资源：字节形式 → JSON 对象 → Java 对象
- 非 JSON 形式文件（如纹理）：
- 读取资源：字节形式 → Java 对象
- JSON 形式文件（如战利品表、模型）：
- 运行时资源包
- JSON 形式文件（旧版本）：
- 生成资源：Java 对象 → JSON 对象 → 字节形式
- 读取资源：字节形式 → JSON 对象 → Java 对象
- JSON 形式文件（如模型等）：
- 生成资源：Java 对象 → JSON 对象
- 读取资源：JSON 对象 → Java 对象
- JSON 形式文件（如配方、战利品表等）：
- 生成资源：Java 对象（直接写入资源包）
- 读取资源：Java 对象（直接从资源包读取）
- JSON 形式文件（旧版本）：
纹理及其动态数据（如有）目前也支持动态生成，但一般不使用。
本模组（BRRP）可以是 ARRP 的分支，自 1.0.0 版本开始，已经从 ARRP 模组独立出去，不再提供 ARRP 的功能，且理论上可以同 ARRP 共存。
本模组开放源代码，并在 MPLv2 版权协议下发布。
下面的例子中的
Identifier.of是 1.21 之后的用法。对于 1.20.6 及之前的版本，请使用new Identifier。
运行时资源包在创建和写入内容后，需要注册才能在加载时生效。注册方法如下：
public class MyClass implements ModInitializer {
public static final RuntimeResourcePack pack = RuntimeResourePack.create(Identifier.of("my_mod", "my_pack"));
@Override
public void onInitialize() {
// 你可以在此处调用 pack 的 write 方法以向资源包中写入内容。
RRPCallback.BEFORE_VANILLA.register(resources -> resources.add(pack));
}
}对于 Forge 版本，你可以使用 RRPEvent 来在模组的事件总线上注册资源包，方法如下：
@Mod("my_mod_id")
public class MyClass {
public static final RuntimeResourcePack pack = RuntimeResourePack.create(Identifier.of("my_mod", "my_pack"));
public MyClass() {
// 你可以在此处调用 pack 的 write 方法以向资源包中写入内容。
FMLJavaModLoadingContext.get().getModEventBus().addListener((RRPEvent.BeforeVanilla event) -> event.addPack(pack));
}
}请注意，Forge 版本已经停止更新。
本模组提供的 RRPEventHelper 可以同时支持 Forge 和 Fabric。例如：
public class MyClass implements ModInitializer {
public static final RuntimeResourcePack pack = RuntimeResourePack.create(Identifier.of("my_mod", "my_pack"));
@Override
public void onInitialize() {
// 你可以在此处调用 pack 的 write 方法以向资源包中写入内容。
RRPEventHelper.BEFORE_VANILLA.registerPack(pack);
}
}通常，在 Minecraft 中资源（assets）包括客户端使用的一切用于渲染、显示或播放的文件，包括方块状态（"block states"）、模型（model）、纹理（texture）、语言文件（lang）、声音等。在 Minecraft 中，储存这些内容的包称为“资源包（resource pack）”。这里所说的资源包包括 Minecraft 自带的原版资源包以及 Fabric Loader 和模组提供的资源包，不一定是 resourcepacks 文件夹中的。资源包只会在客户端使用，服务器不使用，但是玩家加入服务器时可能会被要求使用服务器提供的资源包以在客户端安装。语言文件是唯一服务器需要使用的资源。
而数据（data）则包括所有服务器使用的文件，包括配方、战利品表、标签、进度等。服务器创建时（包括单人游戏），数据才会加载。数据包（data pack）存储的数据是服务器使用的，这里所说的数据包包括 Minecraft 原版自带的数据包、Fabric Loader 和模组提供的数据包以及存储在服务器存档（包括玩家单人地图存档）的 data 文件夹中的可安装的自定义数据包。
这里整理一下：资源（assets）由资源包（resource pack）提供，用于客户端。语言文件是服务器唯一使用的资源。数据（data）由数据包提供（data pack）提供，用于服务器。
不过涉及模组开发时，这些概念就有些混乱了。开发模组时，前面所说的“资源”（assets）和“数据”（data）都统称为“资源”（resources），这里所说的“资源包”是模组文件的 resources 文件夹，包括了前文提及的客户端资源和服务器数据（你应该看到了，这里总是会加上“客户端”和“服务器”修饰以避免歧义）。本模组的“运行时资源包”自然也包括客户端资源和服务器数据。
Minecraft 和 Fabric API 的数据生成器（data generator）生成的也不只是数据，而是包括了所有客户端资源和服务器数据的。
这里再整理一下，在涉及模组开发时，资源（resources）和数据（data）的意思其实是一样的，都包括客户端资源服务器数据这两者。为避免歧义，如确实需要表述其中一端使用的，就加上“客户端”与“服务器”修饰。
如果需要将本模组作为您的依赖，并使用本模组的 API，可以有以下几种方法。
在 build.gradle 的 repositories 和 dependencies 部分分别加入以下内容：
repositories {
maven {
url 'https://raw.githubusercontent.com/SolidBlock-cn/mvn-repo/main'
// 如果上面的网址连接不成功，可以尝试使用镜像站。
}
}
dependencies {
modImplementation "pers.solid:brrp-fabric:模组版本-MC版本"
// 注意：对于 Forge 版本，请将上面的 fabric 改为 forge。
// 对于 0.8.1 及以下的版本，请将 pers.solid 改为 net.devtech。但是，不建议使用旧版本。
// modImplementation 和 modApi 的区别在于，当其他项目依赖你的项目，如果你的项目使用的是 modApi，那么其他项目会自动加载你依赖的内容，如果是 modImplementation 则不会。你可以自行选择。
// 请注意：这里的 MC 版本是模组发布时所使用的 MC 版本，与您开发模组时使用的 MC 版本不一定完全一致。请参考模组发布中的版本号。
}注意：自从 1.0.0 版本开始，对于 Fabric 版本，本模组开始依赖 Mod Menu，因此在 Fabric 的情况下，你还需要：
- 在上面的
repositories中再加入以下内容：
// Mod Menu 所需要的存储库（仅限 Fabric）
maven { url "https://maven.terraformersmc.com/releases/" }- 或者将
dependencies中的内容改为：
// 不加载 Mod Menu
modImplementation("pers.solid:brrp-fabric:模组版本-MC版本") {
transitive false
}您需要先下载 brrp-模组版本-MC版本.jar 和 brrp-模组版本-MC版本-sources.jar 这两个文件（可以在 GitHub 的 releases 部分，或者从 Modrinth 中下载），并放在您的设备存储的任意地方（建议直接存储在项目文件夹内或者附近，两个文件都应该放在同一个文件夹内，并且，如有需要，可将下载到的文件加入 .gitignore）。
然后，在 build.gradle 的 repositories 和 dependencies 部分分别加入以下内容：
repositories {
// dir 中的字符串是存储这些文件的文件夹位置，可以是相对位置。
flatDir { dir "存储上述两个 .jar 文件的文件夹路径" }
}
dependencies {
modImplementation "pers.solid:brrp-fabric:模组版本-MC版本"
}上面的“方法一”中的注意事项，对“方法二”也适用。
刷新项目，然后检查该库是否被正常加载。例如，在 IntelliJ IDEA 中，您可以双击 Shift，输入 RuntimeResourcePack，如果找到了这个类，并且类的代码和注释都能够正常加载，说明项目加载正常了。
然后，在您的 Fabric 项目的 fabric.mod.json 中的 depends 部分添加本模组：
{
// [...]
"depends": {
// [...]
// “*”表示“任意版本”。您亦可指定特定版本，如“>=1.0.0”。
// 注意不要在 JSON 里面留下这些注释。
"brrp_v1": "*"
}
}或者，在 Forge 项目的 mods.toml 中，加入：
[[dependencies.'你的模组的id']]
modId = "brrp_v1"
mandatory = true
versionRange = "[1.0.0,)"
ordering = "NONE"
side = "BOTH"