Appearance
Guides β
Start here β
- Concepts β Persistence, replication, and what clients can see.
- Installation and Setup β Add the model and configure
PlayerStateConfig. - API reference β Server, client, and types index with module paths.
- Examples and Best practices β Patterns you can copy.
I want toβ¦ β
Jump straight to a workflow (same shortcuts that used to live in the sidebar):
| Goal | Page |
|---|---|
| Persist and load data | Concepts |
| Install the model | Installation |
| Configure PlayerStateConfig | Setup |
| Hide data from clients | Data visibility |
| Keep saved fields off the Replica | Server-only data |
| Server-wide temporary state | Shared session |
| Non-persistent session fields | Session data |
| React to changes (server listeners) | Server change listeners |
| React to changes (client listeners) | Client change listeners |
| Migrate old saves | Migration |
Topic guides β
- Leaderstats & paths β Mapping HUD stats to data and using dot paths effectively.
Other focused guides (site map) β
New features get a short entry in What's new first, then deeper pages when needed.