Skip to main content

ProjectZ-CrossSDK Documentation

Cross-backend SDK for a Unity mobile game. The client calls one set of Manager APIs; underneath, requests route to either Unity Gaming Services (UGS) or Nakama, switchable at runtime with automatic fallback.

The docs are split by audience — pick your track:

🎮 Client Guide​

For the UI / game-studio team. You only present data: inject a Manager, subscribe to its reactive state, call methods, render DTOs. You never touch the SDK facade, a provider, or the raw API.

→ Start here: Client — Overview · Getting Started · Manager reference

🛠 SDK Team Guide​

For CrossSDK team members who build the game module (data + logic) for other games. You write Manager → UseCase → Cache → service, wire up VContainer, package the DLLs, and version them.

→ Start here: SDK Team — Overview · Architecture · Add a Manager · New game module

The three roles
  1. CrossSDK core (3 DLLs, game-agnostic) — reused by every game.
  2. Per-game data+logic (<Game>.Backend + <Game>.Models, 2 DLLs) — the CrossSDK team builds this for each game.
  3. Client/UI — the game studio, presents data only, through the Manager APIs.

The Client track = role 3. The SDK Team track = roles 1 & 2.