OGI-Addon

A library to interface with OpenGameInstaller's addon system.

Installation

bun add ogi-addon

Documentation

• First addon guide
• Configuration setup
• Discover catalogs and carousel
• Action buttons and tasks
• Game update support
• Migration guide (v2.0.x to v2.1)

Example Addon

See test-addon for an end-to-end example: test-addon

addon.json Boilerplate

Your addon should include an addon.json file that describes setup and runtime scripts.

interface AddonFileConfigurationSchema {
  author: string;
  scripts: {
    setup?: string;
    run: string;
    preSetup?: string;
    postSetup?: string;
  };
}

Local Development in OGI

In OpenGameInstaller, go to Settings > General and use the local: prefix to point to your addon path.

Example:

local:C:\Users\[you]\Documents\Addon\

Disable Signature Requirement (Debug Only)

If you need to debug outside normal launch flow, you can disable signature checks.

Warning: this is unsafe and allows unsigned programs to connect to the addon server.

To disable, go to Settings > Developer, select Disable Server Secret Check, and restart OGI.