Skip to content

LEGACY UI Vortex In Game Overlay

Simon Davies edited this page Apr 30, 2024 · 2 revisions

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.

Vortex

Games

Starfield

  • Troubleshooting
  • Developers

Baldur's Gate 3

  • Troubleshooting
  • Developers
  • Valheim
  • Bannerlord

Tools

  • BepInEx

Developers

Extensions

Outdated Documentation

Warning

The below documentation has not been checked for quality since migrating to GitHub Wiki and the information contained is potentially out of date and\or repeated.

Modding.wiki (Users)

General

User Interface

Game Guides

Troubleshooting

Modding.wiki (Developers)

General

Reference

Troubleshooting

Other links

Legacy

General

Tutorial

UI

Language

Feature

Harmony Patcher

Other

Clone this wiki locally