Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vortex In Game Overlay #15

Open
IDCs opened this issue Nov 3, 2020 · 0 comments
Open

Vortex In Game Overlay #15

IDCs opened this issue Nov 3, 2020 · 0 comments
Labels
Article Harmony Patcher Anything tied to Vortex's Harmony Patcher API UI

Comments

@IDCs
Copy link
Contributor

IDCs commented Nov 3, 2020

The VIGO module is currently only available for Unity3D games. It provides an in-game UI which users can use to view the currently loaded mods and modify their settings if the mods provide customizable options.

Upon positive identification of a Unity Engine game, the patcher executable will inject the VIGO patch method call above the mod loader’s patch method and subscribe to any relevant events it may emit, thus connecting the mod loader to VIGO and forwarding it the list of loaded exposed mods.

Exposed mods are able to subscribe to several predefined MonoBehaviour hooks such as

Update, FixedUpdate, LateUpdate, and most importantly under the current context, the OnGUI hook which will invoke the selected mod’s subscribed function whenever the Overlay re-renders. This is useful when the mod author wishes to provide the users with the ability to change mod settings/options inside the game, or provide a button which adds 1000XP whenever it’s pressed. It’s important to note that any UI elements inserted inside the OnGUI hook must use Unity’s Immediate Mode GUI (IMGUI)

To bring up the overlay inside the game, simply press down the Ctrl + F12 key combination.

@IDCs IDCs added Article Harmony Patcher Anything tied to Vortex's Harmony Patcher API UI labels Nov 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Article Harmony Patcher Anything tied to Vortex's Harmony Patcher API UI
Projects
None yet
Development

No branches or pull requests

1 participant