Tango's Dynamic Hud Lib

Tango's HudLib

Tango's HudLib — небольшая клиентская библиотека для Fabric, позволяющая создавать перемещаемые HUD-виджеты.

Сам мод не добавляет крупных игровых функций. Он предоставляет API, которое другие моды могут использовать для регистрации HUD-элементов. Для игроков это означает, что TangosHudLib отрисовывает и хранит виджеты, которые другой мод регистрирует через эту библиотеку.

Использование в игре

1. Установи мод вместе с Fabric API.
2. Запусти игру с модом, который регистрирует виджеты через TangosHudLib.
3. Открой категорию Tango's HudLib в меню управления Minecraft.
4. Найди HUD Editor (<Название мода>).
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.