Tango的动态HUD库

Tango的动态HUD库

一个小型客户端Fabric库,用于可移动的HUD组件。 提供API供其他模组注册HUD元素。对玩家而言,这意味着TangosHudLib会渲染并存储其他模组通过此l

基础库

Tango's HudLib

Tango's HudLib 是一个小型客户端 Fabric 库,用于可移动的 HUD 组件。

该模组本身不添加主要的游戏玩法功能。它提供了一个 API,其他模组可以用它来注册 HUD 元素。对玩家而言,这意味着 TangosHudLib 会渲染并存储其他模组通过此库注册的组件。

游戏内使用

  1. 与 Fabric API 一起安装该模组。
  2. 使用通过 TangosHudLib 注册组件的模组启动游戏。
  3. 在 Minecraft 控制菜单中打开 Tango's HudLib 分类。
  4. 查找 HUD Editor (<Mod Name>)。
  5. 在游戏中按下所分配的按键,打开该模组的 HUD 编辑器。
  6. 用鼠标左键拖动组件来移动它们。
  7. 使用相同的快捷键或 Esc 关闭编辑器。

组件位置存储在 config/tangos-hud-lib.json 中。

在你自己的模组中使用

最小且干净利落的集成包含两部分:

  1. 一个带有 static 方法且方法上标注 @HudWidget 的类。
  2. 在你的 ClientModInitializer 中进行一次注册调用。

示例

package eu.example.mod;

import eu.tango.tangosHudLib.api.HudContent;
import eu.tango.tangosHudLib.api.HudLibrary;
import eu.tango.tangosHudLib.api.HudWidget;
import net.fabricmc.api.ClientModInitializer;
import net.minecraft.client.MinecraftClient;
import net.minecraft.text.Text;
import net.minecraft.util.Formatting;
import org.lwjgl.glfw.GLFW;

public final class ExampleModClient implements ClientModInitializer {
    @Override
    public void onInitializeClient() {
        HudLibrary.registerWidgets("examplemod", GLFW.GLFW_KEY_H, ExampleWidgets.class);
    }

    public static final class ExampleWidgets {
        private ExampleWidgets() {
        }

        @HudWidget(id = "position")
        public static HudContent position() {
            MinecraftClient client = MinecraftClient.getInstance();
            if (client.player == null) {
                return HudContent.builder()
                    .line(Text.literal("Position").formatted(Formatting.GOLD))
                    .line(Text.literal("No world loaded").formatted(Formatting.GRAY))
                    .build();
            }

            return HudContent.builder()
                .line(Text.literal("Position").formatted(Formatting.GOLD))
                .line(Text.literal(
                    client.player.getBlockX() + " "
                        + client.player.getBlockY() + " "
                        + client.player.getBlockZ()
                ).formatted(Formatting.WHITE))
                .build();
        }
    }
}

@HudWidget 的规则

组件方法必须:

  • 是 static
  • 没有参数
  • 返回 HudContent
  • 使用非空的 id

HudContent 必须包含至少一个非空行:

HudContent.builder()
    .line(Text.literal("Title"))
    .line(Text.literal("Content"))
    .build();

API 摘要

  • HudLibrary.registerWidgets(String ownerId, int defaultKey, Class<?> clazz) 注册类中所有 @HudWidget 方法,并分配一个默认的 HUD 编辑器快捷键。
  • HudLibrary.registerWidgets(String ownerId, Class<?> clazz) 注册组件而不分配默认快捷键。
  • HudLibrary.registerWidgets(Class<?> clazz) 使用库的默认值 tangos-hud-lib 和 H。