法术渲染器

法术渲染器

一个为Minecraft设计的快速、轻量级OpenGL封装库,用于通过简洁流畅的API渲染2D对象。

基础库

✨ Spell Renderer

适用于 Fabric 模组的现代 2D UI 渲染:圆角面板、液态玻璃、清晰文字与可拖拽 HUD,全部通过一套流畅的 API 实现。

预览

在 Minecraft 中构建美观的界面通常意味着要与 GuiGraphics 较劲,或者自己编写原生 OpenGL。Spell Renderer 为你提供一个小巧、可链式调用的构建器。你描述一个形状并调用 .submit(),库会负责处理着色器、批处理、缩放和裁剪。

📦 这是一个库模组。 它本身不会向游戏添加任何内容。如果有其他模组需要它,请安装它,或用它来构建你自己的 UI。


🎨 可以绘制的内容

形状 用途
矩形 带圆角的面板和按钮,每个角可设置不同半径,并支持渐变颜色
圆形 圆点、指示器、头像
图像 带可选圆角的纹理
文本 任意大小下都清晰的文本,使用 MSDF 字体
图标 来自你自己图标字体的命名图标,例如 Builder.icon("settings")
玻璃 磨砂或液态玻璃面板,可调节模糊、折射等效果

🧊 新功能:液态玻璃

玻璃面板已从头重建。每个面板都有独立的设置:

  • 模糊。 从几乎不可见到重度磨砂,任意半径的开销都相同,因此重度模糊不会拖慢你的 UI。
  • 折射。 边缘像透镜一样弯曲背景,营造液态玻璃效果。设为 0 即为平坦的磨砂玻璃。
  • 色散。 沿边缘产生细微的 RGB 边缘。
  • 饱和度。 让玻璃后的背景更鲜艳,或将其变为灰度。
  • 高光。 沿边缘的一圈细光。
Builder.glass()
        .pos(20, 20)
        .size(200, 120)
        .radius(16)
        .blur(16)
        .refraction(0.9f)
        .chromatic(4)
        .saturation(1.4f)
        .highlight(0.3f)
        .submit();

玻璃现在在任何 UI 缩放下外观都一致,玻璃叠加玻璃的效果也符合预期。

⚡ 功能

  • 🔗 流畅构建器。 用一条可读的链式调用完成形状的定位、尺寸、颜色、圆角和淡出。
  • 🖱️ 可拖拽形状。 为形状添加 .draggable("id"),玩家即可用鼠标移动它。其子级会随之移动,它不会离开屏幕,其位置可保存和恢复。
  • 👪 父子关系。 将形状附加到父级,它们会跟随父级的位置、深度和不透明度。
  • 🚀 批处理渲染。 相同类型的形状会在一次绘制调用中一起绘制。
  • 🔤 MSDF 文本。 文本在任何缩放和任何 GUI 大小下都保持清晰。
  • ✂️ 剪刀裁剪。 将绘制裁剪到某个区域,适用于滚动列表和遮罩面板。
  • 🔍 缩放。 独立于 Minecraft 的 GUI 缩放来缩放你的整个 UI。
  • 🧭 渲染上下文。 在游戏过程中的 HUD 上绘制,或在所有界面之上的 GUI 层绘制。(世界渲染正在开发中。)

🧑‍💻 代码示例

SpellRenderer.on(RenderContext.HUD, () -> {
    var panel = Builder.rect()
            .pos(20, 20)
            .size(220, 80)
            .radius(12)
            .color(new Color(30, 30, 40))
            .draggable("my-panel");   // 玩家可以在聊天打开时移动它
    panel.submit();

    Builder.text("Hello, Spell!")
            .pos(12, 12)
            .size(24)
            .parent(panel)            // 与面板一起移动
            .submit();
});

📥 开始使用

从 Modrinth Maven 添加:

repositories {
    maven { url = "https://api.modrinth.com/maven" }
}

dependencies {
    modImplementation "maven.modrinth:spell-renderer:<version>"
    include "maven.modrinth:spell-renderer:<version>" // 可选:将其打包进你的模组
}

Maven 配置、添加字体和图标以及完整 API 请参阅 GitHub 上的文档。

📋 要求

  • Minecraft 1.21.8
  • Fabric Loader 0.18.5+
  • Fabric API
  • Java 21

💬 发现 bug 或有想法?

请在 GitHub 上提交 issue。欢迎反馈和贡献!