LowFrame Screen API

模组

· 作者 DwayneTheRockJohnson

LowFrame Screen API 是一款高度可定制的屏幕 API,专为开发者设计。

0 本站下载 0 关注 更新于 4 个月前

最新 1.0.0 · 1.21.11 · Fabric

一键开服(送7天)

LowFrame Screen API

一个面向 Minecraft Fabric 模组的轻量级、已样式化的屏幕与组件工具包。

LowFrame Screen API 处理自定义 Minecraft 界面中的重复性工作——包括屏幕生命周期、组件渲染、鼠标和键盘事件分发、工具提示以及统一的样式——让你可以专注于屏幕的实际功能。

这是一个开发者库。单独安装它不会添加任何菜单或游戏内功能。它是使用 LowFrame Screen API 构建界面的模组所必需的依赖。

特性

  • 轻量级的客户端 API
  • 支持样式的按钮、文本字段、开关和滑块
  • 用于自定义屏幕的简单基类
  • 自动的组件渲染与输入分发
  • 悬停检测与工具提示
  • 屏幕级别的鼠标、键盘、字符输入、拖拽和滚动钩子
  • 面板、矩形、边框、文本和颜色的辅助工具
  • 通过 LFWidget 支持自定义组件
  • 无 Fabric API 依赖

兼容性

要求 版本
Minecraft 1.21.11
Mod 加载器 Fabric
Fabric Loader 0.19.3 或更高版本
Java 21 或更高版本
环境 客户端

Minecraft 在不同版本间会更改其 GUI 方法。仅使用与你确切 Minecraft 版本匹配的 Screen API 发布版。

玩家安装指南

  1. 为 Minecraft 1.21.11 安装 Fabric Loader。
  2. 下载 LowFrame Screen API。
  3. 将 JAR 文件放入你的 Minecraft mods 文件夹中。
  4. 安装需要 LowFrame Screen API 的模组。

开发者安装指南

下载 JAR 文件并将其放入你项目的 libs 目录中:

dependencies {
    modImplementation files("libs/lowframe-screen-api-1.0.0.jar")
}

在你的 fabric.mod.json 中添加依赖:

{
  "depends": {
    "fabricloader": ">=0.19.3",
    "minecraft": "~1.21.11",
    "lowframe_screen_api": ">=1.0.0"
  }
}

快速示例

import dev.lowframe.gui.api.LFButton;
import dev.lowframe.gui.api.LFScreen;
import dev.lowframe.gui.api.LFTextField;
import net.minecraft.client.gui.screen.Screen;

public final class ExampleScreen extends LFScreen {
    private final Screen parent;
    private LFTextField name;

    public ExampleScreen(Screen parent) {
        super("Example Screen");
        this.parent = parent;
    }

    @Override
    protected void build() {
        int panelWidth = 220;
        int x = (width - panelWidth) / 2;
        int y = height / 2 - 30;

        name = add(new LFTextField(x, y, panelWidth, 20, "Player name"));

        LFButton save = add(new LFButton(
            x, y + 28, panelWidth, 20, "Save",
            () -> System.out.println(name.getText())
        ));

        save.accent();
        save.tooltip = "Save the entered name";
    }

    @Override
    public void close() {
        client.setScreen(parent);
    }
}

从客户端代码打开屏幕:

MinecraftClient client = MinecraftClient.getInstance();
client.setScreen(new ExampleScreen(client.currentScreen));

内置组件

  • LFButton — 带有标签、动作、工具提示和强调样式的可点击按钮
  • LFTextField — 轻量级单行文本输入框
  • LFToggle — 使用 getter 和 setter 函数的布尔开关控件
  • LFSlider — 使用 getter 和 setter 函数的数值滑块
  • LFWidget — 用于创建自定义组件的基类
  • LFScreen — 带有渲染、生命周期、输入和工具提示处理的基屏幕

重要渲染说明

Minecraft 1.21.11 可能会在渲染你的屏幕之前应用菜单模糊效果。请勿在 LFScreen 中再次调用原版 renderBackground(...),因为 Minecraft 可能会崩溃并抛出以下异常:

IllegalStateException: Can only blur once per frame

请使用 super.renderScreen(...) 或自行绘制背景填充。

文档与源码

  • 完整文档包含在源仓库的 wiki/index.html 中。
  • 源代码仓库:
  • 问题追踪器:

许可证

LowFrame Screen API 采用 LowFrame Attribution-ShareAlike License 1.0 许可证。

你可以出于任何目的使用、修改、重新分发、再许可和销售本库。如果你分发该 API 或基于它的实质性衍生作品,你必须:

  1. 给予 Astro Tech Inc. 合理的署名。
  2. 使用相同的许可证并包含其许可证文本。

私有修改无需公开。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源