?
Host a server
Modrinth App
Sign in
ModsPluginsData PacksShadersResource PacksModpacks
Settings
InGame Info Reborn

InGame Info Reborn

In-game HUDs and GUIs done with structure ā€” reactive, declarative, composable, and built to handle the rest.

253
1

Compatibility

Minecraft: Java Edition

1.12.2

Platforms

Supported environments

Client and server

Links

Report issues View source Visit wiki

Creators

tttsaurus
tttsaurusMember

Details

Licensed MIT
Published 10 months ago
Updated 6 months ago

InGame Info Reborn

"In-game HUDs and GUIs done with structure ā€” reactive, declarative, composable, and built to handle the rest."


Versions Downloads Downloads

This is a Work-In-Progress spiritual successor of InGame-Info-XML, not a fork. If you like this project, don't forget to give it a starā­!

Suggestions/PRs are welcome

Overview

This is a library mod that helps you to create in-game overlaid (or focused) GUI with ease.

Snipaste_2025-01-12_12-53-07 (Nothing will pop up with the default configuration!)

Architectural Modules Chart

Click to Expand
Module Role Status
MVVM Base Separates logic (ViewModel) from rendering (View) āœ… Done
XAML-Style DSL For View Declarative XAML-style layout to build static UI trees āœ… Done
Reactive Binding View reacts to changes in ViewModel automatically āœ… Done
Compose (Injected via Slot) Immediate-mode UI embedded in ViewModel āš ļø Partially
Snapshot Diffing Virtual tree diffing for Compose-based UI āœ… Done
Shared Context Shared runtime context between ViewModel and Compose blocks āœ… Done
DOM-Like Event System Input propagation and event capturing/bubbling āœ… Done
Interactable Control Captures input, intercepts propagation (works with Event System) āœ… Done
Fixed / Render Update Dual update loop for logic vs render āœ… Done
Annotation Driven Auto-Interpolation Utility for smooth interpolation during render updates āœ… Done
Render Op Queue Abstract draw commands for controls āœ… Done
UI Decoration Draw custom visuals on existing controls āœ… Mostly Done
Transition API Externally trigger view transitions šŸš§ Planned
Theme Manager Global theme system (colors, font scale, etc) āœ… Mostly Done
Modal Layer Stack-based modal / dialog system šŸš§ Planned

Example

<VerticalGroup>
    <Text uid = "fps">
    ...
</Group>

// snippet from View and ViewModel classes
@Reactive(targetUid = "fps", property = "text", initiativeSync = true)
public ReactiveObject<String> fpsText = new ReactiveObject<>(){};

EventCenter.gameFpsEvent.addListener((fps) ->
{
    fpsText.set("FPS: " + fps);
});

// registration entry point
@SubscribeEvent
public static void onIgiRuntimeEntryPoint(IgiRuntimeEntryPointEvent event)
{
    event.runtime.initPhase
            .registerMvvm("example", ExampleViewModel.class)
            .openGuiOnStartup("example");
}

Wiki

Implementation Todo List / Overview

Click to Expand

Currently working on the architecture.
Not adding controls or QoL updates.

My Detailed Todo List:

Implementation Overview:

  • Add framebuffer to the GUI rendering life cycle (āœ”)
  • Introduce a custom GUI container (āœ”)
  • Maintain a list of GUI containers so that GUIs can stack together (āœ”)
  • A GUI container can be ingame-overlaid/focused (runtime switchable) (āœ”)
  • Introduce feature-rich GUI layout
    • Pivot (āœ”)
    • Alignment (āœ”)
    • Padding (āœ”)
    • Horizontal Group (stack elements horizontally) (āœ”)
    • Vertical Group (stack elements vertically) (āœ”)
    • Sized Group (āœ”)
    • Nesting Groups (group in group) (āœ”)
    • Adaptive Group (fit elements into it adaptively)
    • Foldout Group
    • Draggable Group
  • Add controls like text, button, input field, etc.
    • Text (āœ”)
    • Sliding Text (āœ”)
    • Anim Text (āœ”)
    • Button (āœ”)
    • Checkbox
    • Input Field
    • Image (āœ”)
    • Url Image (āœ”)
    • GIF
    • Slide Bar
    • Progress Bar (āœ”)
    • Item (āœ”)
  • Add CrT/Zenscript support (āœ”)
  • Ingame spotify support (go to wiki for details) (āœ”)

Latest Build

In case you want to use the latest action build

  • Go to GitHub Actions
  • Click on the latest workflow
  • Scroll down to the bottom and download the Artifacts
  • Unzip and ingameinfo-[version].jar is the mod file

Credits