Repository navigation
Home
Lyraedan edited this page Sep 24, 2026
·
7 revisions
Welcome to the Wiki for Oxygen Not Included Together, here you will find documentation on the API and any extra bits that might be needed for getting your development environment up and running.
- Setting up publiciser requirement on Linux — build-environment setup for the ONI Together mod itself (not required to use the API)
Find on nuget as "ONI_Together_API" or download the API dll from Releases and link it to your mod.
| Page | What it covers |
|---|---|
| API: Getting Started | Set up a mod that uses the API and detect ONI Together |
| API: Game Events | Subscribe to session, connection and player join/leave events |
| API: Session Info | Session state, host/client checks, user IDs, player cursor/colour |
| API: Custom Packets |
IPacket, registration, send modes, PacketSenderAPI
|
| API: Spawning and Entities | Host-authoritative spawning and NetId lookups |
| API: OxySync | High-level NetworkBehaviour with [SyncVar], [Command], [ClientRpc], [TargetRpc]
|
MIT
Mod development environment setup
ONI Together API