OnlyWorlds Unity SDK

Your OnlyWorlds world, its characters, places and laws, as objects in your Unity game.

This repository is a Unity 6 project with the package embedded in it. The package is Packages/com.onlyworlds.sdk; the project around it is its test bed.

The World Browser (Window → OnlyWorlds → World Browser) on Moppetopia, the demo world.

Install into your own project

In the Package Manager, + → Add package from git URL:

https://github.com/OnlyWorlds/unity-sdk.git?path=/Packages/com.onlyworlds.sdk

The package README has a first run that reads a sample world with no account. The CHANGELOG lists what each version changed.

Working on the SDK

Open this repository as a Unity project (6000.0 or later). The package is embedded, so edits are live.

Tests: Window → General → Test Runner → EditMode, assembly OnlyWorlds.Sdk.Tests.Editor. They need no network.

The live-API tests in Tests/Integration are skipped twice over:

1. Their assembly compiles only with the OW_INTEGRATION_TESTS define. It is an Editor assembly, so add the define under Project Settings → Player → Scripting Define Symbols for the Editor platform; a player target's symbols don't reach it.
2. Every test is [Explicit], so Run All skips them. Run them one at a time.

They need a key and a network.

The 22 element models are generated from the schema distribution by codegen/generate_models.py, and codegen/check_drift.py checks that they still match it.

OnlyWorlds

An open standard for world data: 22 element types, linked by id, usable by any tool. The schema lives at OnlyWorlds/OnlyWorlds. Other clients: the TypeScript SDK and the Python SDK.

Licence

MIT. See LICENSE.