Client SDK API reference

Client SDK pages document the APIs a game client can call or bind to. Examples on these pages should use synchronized engine tabs for every shipped client target: Unreal C++, Unreal Blueprint, Unity C#, Godot GDScript, Rust (citadel-client), and JavaScript/Web when the surface exists there.

Current shipped targets

Citadel ships Unreal, Unity, Godot (native plus a Godot Web export), Rust, and a WebSocket JavaScript SDK today. JavaScript examples appear for connection, authentication, generic RPC, and notification streams; binary engine helpers remain engine-specific.

SDK bindings

From a repository checkout, use make bin-client-<engine> to stage the copy-into-project package under bin/clients/<engine>/; see Make targets. JavaScript is currently staged from source rather than installed from npm. For a visual browser-game integration, begin with the runnable @citadel/client + Three.js starter; the SDK itself remains renderer-neutral.

• Rust SDK
• C ABI

Modules

• Authentication
• Rooms
• Matchmaker
• Maps
• Transform sync
• Networked actors
• NetworkPeer property replication
• Player notifications