Getting Started¶
This is the quick path from nothing to a world other people can join. Each step links to the page with the full detail.
1. Set up the SDK¶
- Start from a Universal Render Pipeline (URP) project — Social Scape renders with URP, so a Built-in-pipeline project shows content wrong (pink materials, or imported assets rendering incorrectly). Use Unity's URP template when creating the project, or install the Universal RP package first.
- Import the Social Scape SDK Unity package into your project. On first open it sets the project to URP if it
isn't already (or run
Social Scape ▸ SDK ▸ Set Up URP Renderinganytime). - Open
Social Scape ▸ SDK Control Panel— your hub for building and uploading. - Sign in with your SDK account (also used by the Provider Manager).
2. Build a world¶
- Create or open a scene.
- Add a
WorldDescriptorto the root GameObject (Social Scape/World Descriptor). - Place a
primarySpawnPointso players have somewhere to arrive. - Set capacity, access, and any lighting/audio you want.
→ Full detail: Worlds.
3. (Optional) Make it interactive¶
- Scripts: write a NexusScript (a
NexusBehaviour) and put it on aNexusComponent— triggers, doors, scoreboards, anything. - AI NPC: add an
SSAINpc, give it a personality and a provider, and wire actions & events.
The Examples are the fastest way to start — drop one in and adapt it.
4. Test before you upload¶
Social Scape ▸ SDK ▸ Create Test Player (FPS), press Play, and walk your world — triggers, interactables, UI (both stacks), gravity zones and VR all work offline, and the tester applies the same rules the platform applies at load, so what passes here passes live. → Testing your world.
5. Upload¶
- Open
Social Scape ▸ Content Manager. - Build your world — the SDK packages it and captures a thumbnail.
- Upload — it gets an id and goes live; players can join instances.
→ Full detail incl. the "don't override picture" option: Worlds ▸ Build & upload.
What ships with your world¶
Your scene, your NexusScripts, and your AI NPC configuration all travel inside the upload. The only thing that doesn't is your provider API keys — those stay encrypted on your account and are resolved by handle at runtime (Providers & keys).
Where to go next¶
| Goal | Page |
|---|---|
| Script world logic | NexusScript |
| Add a talking character | AI NPCs |
| Custom avatars | Avatars |
| Something's wrong | Troubleshooting |