API: Getting Started

This page is accurate as of version 0.8.

A companion NuGet package (ONI_Together_API) that lets third-party mods add multiplayer features via ONI Together.

The API is reflection-based and null-safe: every call degrades to a no-op (returns false / null / 0) when the ONI Together mod is not installed, disabled. You can ship a single mod that works with or without multiplayer present.

Requirements

• Oxygen Not Included with the ONI Together mod installed and enabled.
• .NET Standard 2.1 compatible project

Installation

Install the API from nuget via "ONI_Together_API" or build the dll and link your project to it.

Detecting ONI Together

Ideally, you should gate multiplayer behaviour behind a presence check:

using ONI_Together_API;

if (MP_Mod_Info.MultiplayerModPresent)
{
    // ONI Together is loaded and enabled
}

MP_Mod_Info.MainMpModType returns the main mod's UserMod2 Type (or null). Both members are safe to access at any time.