TLA Api

模组

· 作者 MattiDragon

一个为 Minecraft 配方查看器 API 提供的抽象层。

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

需要前置:Fabric API

最新 1.2.1+mc.1.21 · 1.21 · Fabric / Quilt

一键开服(送7天)

TLA Api

TLA api 是 Minecraft 配方查看器 API 的抽象层。 它允许模组开发者只需编写一次配方查看器的集成代码,即可兼容多种配方查看器。 目前支持的配方查看器有:EMI 和 REI。

用法

Gradle

TLA api 可通过 JitPack 获取。在 build.gradle 中添加以下内容以使用它:

repositories {
    maven {
        url "https://jitpack.io"
    }
}

dependencies {
    modImplementation "com.github.mattidragon:TlaApi:${tla_api_version}"
    include "com.github.mattidragon:TlaApi:${tla_api_version}"
}

入口点 (Entrypoint)

要使用该 API,你需要实现 TlaApiPlugin 接口,并将你的实现添加到 tla-api 入口点中。 请注意,整个 API 仅适用于客户端。如果你使用了分离的源码集(split source sets), 则需要在客户端源码集中实现该 API。

public class MyTlaPlugin implements TlaApiPlugin {
    @Override
    public void register(PluginContext context) {
        // 在此处注册你的 API
    }
}
{
  "entrypoints": {
    "tla-api": [
      "my.package.MyTlaPlugin"
    ]
  }
}

注册内容

设置好入口点后,你就可以开始注册内容了。 整个 API 都通过 Javadoc 进行了文档说明,因此你可以使用 IDE 来探索该 API。 API 的设计主要基于 EMI,但我为了适配 REI 做了一些修改。

注意事项

虽然 TLA API 抽象了一切,但你仍需自行验证代码是否在两种配方查看器上都能正常工作。 例如,你仍然需要为 EMI 翻译所有的标签(tags)。某些小部件的渲染方式也可能略有不同。

在使用该 API 时,建议关注以下注解。 它们有助于解释如何正确使用该 API。

  • @ApiStatus.Internal: 表示这部分代码不打算供模组开发者使用。
  • @ImplementationOnly: 表示这部分代码仅用于配方查看器的 API 实现部分。 除非你在创建自己的配方查看器集成,否则不应使用这些 API 部分。
  • @PluginOnly: 表示这部分代码仅由插件使用,而非配方查看器的 API 实现。
  • @ImplementationsExtend: 表示该接口由 API 的实现部分所实现,插件通常不应实现它。
  • @PluginsExtend: 表示该接口由插件实现,而 API 的实现部分通常不应实现它。

常见问题

Q: 这是否允许仅支持单一查看器的模组在两者上都能工作?

A: 不可以。此 API 只是让模组开发者更容易同时支持这两种查看器。

Q: 为什么这个 API 仅适用于客户端?

A: EMI 的整个 API 都是仅适用于客户端的。REI 虽然有服务端 API,但不包含 TLA 所使用的任何功能。

Q: 有示例吗?

A: 有的,你可以在这里找到测试模组。 它做了一些通常不会做的操作,但总体上很好地展示了该 API 的用法。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源