游戏内信息重制版

游戏内信息重制版

游戏内HUD和GUI以结构化方式实现——响应式、声明式、可组合,并旨在应对其余一切。

基础库

InGame Info Reborn

"结构化的游戏内 HUD 和 GUI——响应式、声明式、可组合,并能处理其余一切。"


Versions Downloads Downloads

这是 InGame-Info-XML 的一个开发中精神续作,不是分支。 如果你喜欢这个项目,别忘了给它点个星⭐!

欢迎提出建议/PR

概述

这是一个库模组,帮助你轻松创建游戏内叠加(或聚焦)GUI。

Snipaste_2025-01-12_12-53-07 (默认配置下不会弹出任何内容!)

架构模块图

点击展开
模块 作用 状态
MVVM 基础 将逻辑(ViewModel)与渲染(View)分离 ✅ 已完成
用于 View 的 XAML 风格 DSL 声明式 XAML 风格布局,用于构建静态 UI 树 ✅ 已完成
响应式绑定 View 自动响应 ViewModel 中的变化 ✅ 已完成
Compose(通过 Slot 注入) 嵌入 ViewModel 的即时模式 UI ⚠️ 部分完成
快照差异 基于 Compose 的 UI 的虚拟树差异 ✅ 已完成
共享上下文 ViewModel 与 Compose 块之间的共享运行时上下文 ✅ 已完成
类 DOM 事件系统 输入传播与事件捕获/冒泡 ✅ 已完成
可交互控件 捕获输入、拦截传播(与事件系统配合工作) ✅ 已完成
固定/渲染更新 逻辑与渲染的双更新循环 ✅ 已完成
注解驱动的自动插值 用于在渲染更新期间进行平滑插值的工具 ✅ 已完成
渲染操作队列 控件的抽象绘制命令 ✅ 已完成
UI 装饰 在现有控件上绘制自定义视觉效果 ✅ 基本完成
过渡 API 从外部触发视图过渡 🚧 计划中
主题管理器 全局主题系统(颜色、字体缩放等) ✅ 基本完成
模态层 基于栈的模态/对话框系统 🚧 计划中

示例

<VerticalGroup>
    <Text uid = "fps">
    ...
</Group>
// 来自 View 和 ViewModel 类的片段
@Reactive(targetUid = "fps", property = "text", initiativeSync = true)
public ReactiveObject<String> fpsText = new ReactiveObject<>(){};

EventCenter.gameFpsEvent.addListener((fps) ->
{
    fpsText.set("FPS: " + fps);
});
// 注册入口点
@SubscribeEvent
public static void onIgiRuntimeEntryPoint(IgiRuntimeEntryPointEvent event)
{
    event.runtime.initPhase
            .registerMvvm("example", ExampleViewModel.class)
            .openGuiOnStartup("example");
}

Wiki

实现待办列表 / 概述

点击展开

当前正在开发架构。
未添加控件或体验优化更新。

我的详细待办列表:

实现概述:

  • 将帧缓冲添加到 GUI 渲染生命周期中 (✔)
  • 引入自定义 GUI 容器 (✔)
  • 维护 GUI 容器列表,以便 GUI 可以堆叠在一起 (✔)
  • GUI 容器可以是游戏内叠加/聚焦的(运行时切换) (✔)
  • 引入功能丰富的 GUI 布局
    • 轴心点 (✔)
    • 对齐 (✔)
    • 内边距 (✔)
    • 水平组(水平堆叠元素) (✔)
    • 垂直组(垂直堆叠元素) (✔)
    • 固定尺寸组 (✔)
    • 嵌套组(组中组) (✔)
    • 自适应组(自适应容纳元素)
    • 折叠组
    • 可拖动组
  • 添加文本、按钮、输入框等控件
    • 文本 (✔)
    • 滑动文本 (✔)
    • 动画文本 (✔)
    • 按钮 (✔)
    • 复选框
    • 输入框
    • 图像 (✔)
    • URL 图像 (✔)
    • GIF
    • 滑块
    • 进度条 (✔)
    • 物品 (✔)
  • 添加 CrT/Zenscript 支持 (✔)
  • 游戏内 Spotify 支持(详情请见 wiki) (✔)

最新构建

如果你想使用最新的 action 构建

  • 前往 GitHub Actions
  • 点击最新的工作流
  • 滚动到底部并下载 Artifacts
  • 解压后,ingameinfo-[version].jar 即为模组文件

致谢