Papyrus

模组

· 作者 nelind

一个为 Fabric 加载器 MappingResolver 提供多种命名映射的模组

0 本站下载 0 关注 更新于 2 年前

最新 0.2.0+java.21 · 1.21.1 · Fabric

一键开服(送7天)

Papyrus

Papyrus 为 Fabric 加载器的 MappingResolver 提供了多种具名映射(named mappings)。这使得在运行时更友好地访问映射成为可能,例如在反射中使用具名类而非中间层(intermediary)类。 Papyrus 会在首次运行特定版本时下载映射,并将缓存的映射以 tiny v2 格式存储在 ${game_dir}/cache/papyrus/${mapping}_${version}.tiny

使用 Papyrus

要使用 Papyrus,只需将托管 Papyrus 的 Maven 仓库添加到你的 Gradle 构建脚本中:

# Kotlin DSL
repositories {
    maven("https://maven.nelind.dk/releases") {
        name = "Nelind Maven"
    }
}

# Groovy DSL
repositories {
    maven {
        name 'Nelind Maven'
        url 'https://maven.nelind.dk/releases'
    }
}

然后通过标准的 Loom “include” Gradle 配置包含 Papyrus JIJ:

# Kotlin DSL
modRuntimeOnly(include("dk.nelind:papyrus:(version)")!!)

# Groovy DSL
modRuntimeOnly include("dk.nelind:papyrus:(version)")

你也可以选择不包含 Papyrus JIJ;在这种情况下,请确保在 fabric.mod.json 中手动将 Papyrus 添加为依赖项。如果你需要访问 Papyrus 的内部实现,可以使用 modApi 配置而不是 modRuntimeOnly 配置来引入 Papyrus。

然后在 fabric.mod.json 中,你需要告诉 Papyrus 你需要访问哪些映射及其对应版本:

{
  ...
  "custom": {
    "papyrus": {
      "mappings": [
        "mojmap",
        "yarn:build.1"
      ]
    }
  }
}

接着通过任意已添加的映射命名空间获取并使用 MappingResolver:

MappingResolver mappingResolver = FabricLoader.getInstance().getMappingResolver();
String runtimeClassNameFromYarnName = mappingResolver.mapClassName("yarn:build.1", yarnClassName);
String runtimeClassNameFromMojmapName = mappingResolver.mapClassname("mojmap", mojmapClassName);

使用说明:

  • Papyrus 在 preLaunch(预启动)阶段注入所添加的映射,因此你应该在此之后某个时间点才使用 Papyrus。 如果未来 Fabric 加载器插件的相关讨论中有合理理由让 Papyrus 成为加载器插件,它将会这样做。希望届时能在 preLaunch 阶段提供额外的映射。

  • Mojmap 对继承的类成员处理方式与 Intermediary 和 Yarn 不同! Intermediary 和 Yarn 仅针对在其各自映射定义中直接定义的成员提供映射,而 Mojmap 则为该类拥有的所有成员(包括继承而来的)提供名称。在实践中这意味着,如果你在某个类中请求 Mojmap 的方法名,而该类继承了该方法且运行时映射是 Intermediary 或 Yarn,你将得到 null,因为解析器可以找到该名称(在 Mojmap 中),但在运行时映射中该方法没有定义的名称。这对你意味着什么? 如果你使用 Mojmap 名称作为映射解析器的输入,你应该使用方法或字段声明所在的类的类名,而不是你想要修改的类的类名。或者,你可以进行空值检查,并通过编程方式查找该类的超类,然后以该类作为拥有者向映射解析器请求成员名称。

提供的映射

映射类型 映射解析器中使用的命名空间
Mojang Mappings mojmap
Yarn yarn

关于版本控制的说明

由于 Papyrus 几乎完全独立于游戏本身的版本,模组版本号表示该构建所针对的 Java 版本。例如,Papyrus x.y.z+java.17 是针对 Java 17 构建的,因此支持任何同样针对 Java 17 构建的游戏版本(即从 1.18 到 1.20.4 的所有版本,含两端)。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源