SGL(超级GUI库)

SGL(超级GUI库)

Super GUI Lib - 一个无需素材即可创建精美GUI的库。

基础库

SuperGUILib V2 - 增强版 Minecraft GUI 库

一个现代、易于使用的 Minecraft 1.21.11 (Fabric) GUI 库,让创建精美的用户界面变得简单又有趣!

🎮 什么是 SuperGUILib?

SuperGUILib 是一个强大的工具包,帮助 Minecraft 模组开发者创建令人惊艳的图形用户界面,而无需处理复杂的渲染代码。可以把它看作一个“GUI 构建器”,让你只需几行代码就能创建菜单、设置界面和交互式显示!

非常适合:

  • 设置菜单
  • 自定义物品栏
  • 交互式显示
  • 配置界面
  • 游戏内工具和实用程序

✨ 主要特性

  • 🎨 精美的预样式组件 - 按钮、滑块、文本字段等
  • 🖱️ 交互元素 - 点击音效、悬停效果、冷却时间
  • 📜 自动滚动 - 自动处理内容溢出
  • 🎯 物品显示 - 显示 Minecraft 物品及其提示信息
  • 🎵 自定义音效 - 为你的界面添加音频反馈
  • 📱 响应式设计 - 适应不同的屏幕尺寸
  • 🚀 易于使用 - 简单的构建器模式 API

🚀 快速开始

在游戏内试用

运行以下命令查看示例:

/sgl-v2 testgui          - 包含所有特性的增强版示例菜单
/sgl testgui             - 原始示例菜单

创建你的第一个 GUI

import org.stepan1411.super_gui_lib.client.api.GuiBuilder;
import net.minecraft.client.gui.screen.Screen;

public class MyFirstGUI {
    public static Screen create() {
        return GuiBuilder.create("My Settings")
            .panelSize(300, 200)
            
            .label("Welcome to My Mod!")
                .color(0xFFFFFF00)
                .add()
            
            .button("Click Me")
                .onPress(() -> System.out.println("Hello!"))
                .add()
            
            .slider("Volume")
                .value(0.7)
                .onChange(value -> setVolume(value))
                .add()
            
            .build();
    }
}

就这样!你只用了不到 20 行代码就创建了一个包含标签、按钮和滑块的 GUI!

📚 代码示例

示例 1:简单设置菜单

Screen settingsGui = GuiBuilder.create("Game Settings")
    .panelSize(350, 250)
    
    .slider("Master Volume")
        .value(0.8)
        .fillColor(0xFF00FF00)
        .onChange(vol -> game.setVolume(vol))
        .add()
    
    .slider("Brightness")
        .value(0.5)
        .fillColor(0xFFFFAA00)
        .onChange(bright -> game.setBrightness(bright))
        .add()
    
    .button("Apply")
        .surface(Surface.DARK_PANEL)
        .onPress(() -> saveSettings())
        .add()
    
    .button("Cancel")
        .onPress(() -> closeScreen())
        .add()
    
    .build();

示例 2:带冷却时间的交互式按钮

GuiBuilder.create("Combat Menu")
    .panelSize(300, 200)
    
    .button("Quick Attack")
        .cooldownSeconds(1.0)  // 1 秒冷却时间
        .onPress(() -> player.attack())
        .add()
    
    .button("Heavy Attack")
        .cooldownSeconds(3.0)  // 3 秒冷却时间
        .surface(Surface.flat(0xFF660000))
        .onPress(() -> player.heavyAttack())
        .add()
    
    .build();

示例 3:文本输入表单

GuiBuilder.create("Player Registration")
    .panelSize(350, 250)
    
    .label("Enter your name:").add()
    
    .textField()
        .placeholder("Name...")
        .textOnly()           // 只允许字母
        .maxLength(20)
        .onChange(name -> playerName = name)
        .add()
    
    .label("Enter your age:").add()
    
    .textField()
        .placeholder("Age...")
        .numbersOnly()        // 只允许数字
        .maxLength(3)
        .onChange(age -> playerAge = age)
        .add()
    
    .button("Submit")
        .onPress(() -> registerPlayer())
        .add()
    
    .build();

示例 4:自定义样式菜单

GuiBuilder.create("Styled Menu")
    .panelSize(400, 300)
    .panelSurface(Surface.flat(0xE0101010).and(Surface.outline(0xFF00AAFF)))
    
    .label("Super Cool Menu")
        .color(0xFF00FFFF)
        .scale(2.0f)
        .shadow(true)
        .add()
    
    .button("Neon Button")
        .size(250, 25)
        .surface(Surface.flat(0xFF003366).and(Surface.outline(0xFF00FF00)))
        .onPress(() -> doSomething())
        .add()
    
    .build();

🎨 可用组件

组件 描述 用途
Button 支持冷却时间的可点击按钮 操作、导航
Slider 水平/垂直数值选择器 音量、亮度、设置
Label 带样式的文本显示 标题、描述
TextField 带验证的文本输入 用户输入、搜索
ItemDisplay 显示 Minecraft 物品及其提示信息 物品栏、展示
VolumeMeter VU 表风格指示器 音频电平、进度
ScrollContainer 自动滚动容器 长内容列表

🎯 组件特性

按钮

  • 自定义颜色和表面
  • 点击音效
  • 冷却系统
  • 悬停效果
  • 动态文本更新

滑块

  • 水平和垂直
  • 自定义颜色(轨道、填充、手柄)
  • 数值标签
  • 实时回调
  • 平滑拖动

文本字段

  • 占位符文本
  • 仅文本或仅数字验证
  • 最大长度限制
  • 自定义颜色
  • 边框样式

物品显示

  • 显示任何 Minecraft 物品
  • 自动提示信息
  • 可缩放尺寸
  • 自定义背景
  • 动态更新

📦 安装

面向模组开发者

  1. 下载 SuperGUILib-*.jar
  2. 添加到项目的 libs 文件夹
  3. 更新 build.gradle:
dependencies {
    modImplementation files('libs/SuperGUILib-*.jar')
    include files('libs/SuperGUILib-*.jar')
}

从源码构建

./gradlew build

编译后的 JAR 将位于 build/libs/

📖 文档

完整文档请见 SGL-WIKI:

🎮 游戏内命令

使用以下命令测试所有特性:

/sgl-v2 testgui              - 增强版 V2 菜单(推荐!)
/sgl testgui                 - 原始示例菜单

🌈 颜色格式

SuperGUILib 使用 ARGB(Alpha-Red-Green-Blue)格式:

0xAARRGGBB
  ││││││└└─ 蓝色 (00-FF)
  ││││└└─── 绿色 (00-FF)
  ││└└───── 红色 (00-FF)
  └└─────── Alpha (00=透明, FF=不透明)

示例:

  • 0xFFFF0000 - 不透明红色
  • 0x80FF0000 - 半透明红色
  • 0xFF00FF00 - 不透明绿色
  • 0x800033FF - 半透明蓝色

需要帮助? 查看 Wiki