-
Notifications
You must be signed in to change notification settings - Fork 137
LEGACY UI Vortex In Game Overlay
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.
This wiki and the Vortex Readme document contains a lot of information, please take your time and read these instructions carefully.
We provide detailed changes for each Vortex release.
If you have any questions about Vortex usage or want to share some information with the Vortex community, please go to one of the following places:
- About
- Install
- Troubleshooting
- Troubleshooting
- Developers
- Troubleshooting
- Developers
- Valheim
- Bannerlord
- BepInEx
- How to test a game extension
- How to package a game extension
- How to upload an extension to Nexus
- How to submit a game extension for review
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.
- Frequently Asked Questions
- Getting Started
- Deployment Methods
- Downloading from Nexus Mods
- Managing File Conflicts
- Managing your Load Order
- Managing Save Games
- Setting up Profiles
- Keyboard Shortcuts
- How to create mod installers
- External Changes
- The Vortex Approach to Load Order
- Moving Vortex to a new PC
- Modding Skyrim Special Edition with Vortex
- Modding Mount & Blade II: Bannerlord with Vortex
- Modding Monster Hunter: World with Vortex
- Modding The Witcher 3 with Vortex
- Modding Baldur's Gate 3 with Vortex
- Modding Stardew Valley with Vortex
- Modding Valheim with Vortex
- Error Messages
- Misconfigured Documents Folder
- .NET 6 Install Issues
- Downgrading Extensions
- Command Line Parameters
- Introduction to Vortex extensions
- Creating a game extension (JavaScript)
- Creating a theme
- Game detection
- Adding a main page
- Adding a load order page
- Building UI with Vortex and React
- Packaging an extension
- Introduction
- Packaging extensions
- Project management
- Harmony Patcher Exectuable
- Vortex Harmony Mod Loader
- Setting up your dev environment
- Creating a theme
- Creating a game extension