Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tttsaurus/ingame-info-reborn
Inspired by InGame-Info-XML and it's bringing more modular controls and layouts to hud and also mvvm architecture
https://github.com/tttsaurus/ingame-info-reborn
crafttweaker forge ingameinfo minecraft minecraft-mod minecraft112
Last synced: 11 days ago
JSON representation
Inspired by InGame-Info-XML and it's bringing more modular controls and layouts to hud and also mvvm architecture
- Host: GitHub
- URL: https://github.com/tttsaurus/ingame-info-reborn
- Owner: tttsaurus
- License: mit
- Created: 2024-11-22T06:34:36.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-01-19T16:33:38.000Z (18 days ago)
- Last Synced: 2025-01-19T17:38:01.472Z (18 days ago)
- Topics: crafttweaker, forge, ingameinfo, minecraft, minecraft-mod, minecraft112
- Language: Java
- Homepage: https://www.curseforge.com/minecraft/mc-mods/ingame-info-reborn
- Size: 344 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
This is a spiritual successor of [InGame-Info-XML](https://github.com/Lunatrius/InGame-Info-XML), **not a fork**.
If you like this project, don't forget to give it a star⭐!
Currently WIP
Suggestions/PRs are welcome
## Overview
This is a library mod that helps you to create in-game overlaid (or focused) gui with ease.
## Todo List / Features
Click to expand
https://trello.com/b/MTLHeyGn/ingameinfo
- Approximate Model-View-ViewModel pattern (✔)
- Add framebuffer to the rendering life cycle (✔)
- Introduce a custom gui container (✔)
- Maintain a list of custom gui containers (✔)
- A gui container can be ingame-overlaid/focused (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
- Add controls like text, button, input field, etc.
- Text (✔)
- Sliding Text (✔)
- Anim Text (✔)
- Simple Button (✔)
- Checkbox
- Input Field
- Image
- Url Image (✔)
- GIF
- Slide Bar
- Progress Bar (✔)
- Draggable
- Introduce modular animation options for controls (WIP)
- Add crt support (✔)
- Ingame spotify support (✔)
## About Spotify Overlay
Click to expand
Also under early stage of development
Version Requirement: >= v1.0.0-b2
- It depends on the Spotify Web API, so it only works when you are connected to the Internet
- You have to register your own spotify app first and then input the client id & secret to the config file to allow the Web API to function ([About Spotify App](https://developer.spotify.com/documentation/web-api/concepts/apps). Btw, Redirect URI should be set to http://localhost:8888 for this mod to listen)
Specific spotify app config is as follows
- Input the command `#spotify-oauth` to the chat to authorize your spotify app
- After you finished the authentication, input the command `#spotify-gui true` while you're listening to a track on Spotify to open the gui overlay. `#spotify-gui false` for closing ofc
- You can always run `#spotify-gui true` again to refresh
- Album image loading could be slow
- You no longer need to run `#spotify-oauth` for the next launch and so on, but you should run `#spotify-oauth` to refresh if you encountered any issues
- Run `#spotify-gui-edit` to switch to another layout at runtime
## Latest Build
In case you want to use the latest action build
- Go to [GitHub Actions](https://github.com/tttsaurus/Ingame-Info-Reborn/actions)
- Click on the latest workflow
- Scroll down to the bottom and download the `Artifacts`
- Unzip and `ingameinfo-[version].jar` is the mod file
## How to use
API is stabilizing.
Here's an easy example under v1.0.0-b5.
`./config/ingameinfo/test.ixml`
```xml
```
`TestView.java`
```java
public class TestView extends View
{
@Override
public String getIxmlFileName() { return "test"; }
}
```
`TestViewModel.java`
```java
public class TestViewModel extends ViewModel
{
@Reactive(targetUid = "myUid", property = "text", initiativeSync = true)
public ReactiveObject myUidText = new ReactiveObject(){};
@Override
public void start()
{
EventCenter.igiGuiFpsEvent.addListener((fixedFps, renderFps) ->
{
myUidText.set("Fixed FPS: " + fixedFps + ", Render FPS: " + renderFps);
});
}
}
```
```java
@SubscribeEvent
public static void onMvvmRegister(MvvmRegisterEvent event)
{
MvvmRegistry.autoRegister("test", TestViewModel.class);
}
```
```java
IgiGuiManager.openGui("test");
```
The default alignment and pivot are the top-left corner.
Crt version is as follows (install ProbeZS and ZS IntelliSense for more api details)
```zenscript
#loader preinit
import mods.ingameinfo.mvvm.ViewModel;
import mods.ingameinfo.mvvm.View;
import mods.ingameinfo.mvvm.Mvvm;
import mods.ingameinfo.Types;
import mods.ingameinfo.igievent.EventCenter;
Mvvm.define("test");
View.setIxmlFileName("test");
var myUidText = ViewModel.registerReactiveObject("myUidText", Types.String, "myUid", "text", true);
ViewModel.setStartAction(function()
{
EventCenter.addIgiGuiFpsEventListener(function(fixedFps as int, renderFps as int)
{
myUidText.set("Fixed FPS: " ~ fixedFps ~ ", Render FPS: " ~ renderFps);
});
});
```
```zenscript
import mods.ingameinfo.gui.IgiGuiManager;
import mods.ingameinfo.event.IgiGuiInitEvent;
events.onIgiGuiInit(function(event as IgiGuiInitEvent)
{
IgiGuiManager.openGui("test");
});
```
Extra java example:
- [TemplateView](https://github.com/tttsaurus/Ingame-Info-Reborn/blob/master/src/main/java/com/tttsaurus/ingameinfo/common/impl/mvvm/TemplateView.java)
- [TemplateViewModel](https://github.com/tttsaurus/Ingame-Info-Reborn/blob/master/src/main/java/com/tttsaurus/ingameinfo/common/impl/mvvm/TemplateViewModel.java)
Extra Tips:
- Go to `./logs/latest.log`
- Find
```
[00:18:06] [Client thread/INFO] [ingameinfo]: In-Game Info Reborn starts initializing.
[00:18:06] [Client thread/INFO] [ingameinfo]: Reflection setup finished.
[00:18:06] [Client thread/INFO] [ingameinfo]: Network setup finished.
[00:18:06] [Client thread/INFO] [ingameinfo]:
[00:18:06] [Client thread/INFO] [ingameinfo]: Registered usable elements:
[00:18:06] [Client thread/INFO] [ingameinfo]: - UrlImage
[00:18:06] [Client thread/INFO] [ingameinfo]: - SlidingText
[00:18:06] [Client thread/INFO] [ingameinfo]: - Text
[00:18:06] [Client thread/INFO] [ingameinfo]: - VerticalGroup
[00:18:06] [Client thread/INFO] [ingameinfo]: - AnimText
[00:18:06] [Client thread/INFO] [ingameinfo]: - SimpleButton
[00:18:06] [Client thread/INFO] [ingameinfo]: - EmptyBlock
[00:18:06] [Client thread/INFO] [ingameinfo]: - SizedGroup
[00:18:06] [Client thread/INFO] [ingameinfo]: - HorizontalGroup
[00:18:06] [Client thread/INFO] [ingameinfo]: - ProgressBar
[00:18:06] [Client thread/INFO] [ingameinfo]:
[00:18:06] [Client thread/INFO] [ingameinfo]: Element type: Sized extends Element
[00:18:06] [Client thread/INFO] [ingameinfo]: - With style properties:
[00:18:06] [Client thread/INFO] [ingameinfo]: - [float] width (with deserializer: BuiltinTypesDeserializer)
[00:18:06] [Client thread/INFO] [ingameinfo]: - Setter callback pre: nonNegativeFloatValidation
[00:18:06] [Client thread/INFO] [ingameinfo]: - Setter callback post: requestReCalc
[00:18:06] [Client thread/INFO] [ingameinfo]: - [float] height (with deserializer: BuiltinTypesDeserializer)
[00:18:06] [Client thread/INFO] [ingameinfo]: - Setter callback pre: nonNegativeFloatValidation
[00:18:06] [Client thread/INFO] [ingameinfo]: - Setter callback post: requestReCalc
...
```
- Then you'll know what style properties each element has
- As a result, you can write your `ixml` file with ease
## Credits
- Created using [GregTechCEu's Buildscripts](https://github.com/GregTechCEu/Buildscripts)
- Inspired by [InGame-Info-XML](https://github.com/Lunatrius/InGame-Info-XML)