CLI Tool

The quickest way to create an addon is to use create-ogi-addon!

$ bun create ogi-addon

This will setup a simple project skeleton which gets you ready for developing OGI addons!

Manual

Making an OpenGameInstaller addon is simple, as our Type-Safe library lets you connect to the client gracefully without any restraints.

Firstly, install the OpenGameInstaller client by going to our download link.

Then, in a new npm project, run:

$ bun add ogi-addon@latest

Create a .gitignore file

It is additionally recommended that you create a .gitignore file to protect your development environment from leaking important info. Here is a basic template you can use:

# dependencies
node_modules/
# required because crashes make a *-crash.log file and client uses an installation.log file to verify addon installs.
*.log
# add this because auto-update doesn't like it when lock files are committed.
bun.lockb

Follow the next guide to learn how to create an addon.json file, which is essential for OpenGameInstaller to get metadata about your addon.