Skip to content

How-and-why guides and workflows. Use the API reference to look up every function and type.

Guides ​

Start here ​

  1. Concepts β€” Persistence, replication, and what clients can see.
  2. Installation and Setup β€” Add the model and configure PlayerStateConfig.
  3. API reference β€” Server, client, and types index with module paths.
  4. 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):

GoalPage
Persist and load dataConcepts
Install the modelInstallation
Configure PlayerStateConfigSetup
Hide data from clientsData visibility
Keep saved fields off the ReplicaServer-only data
Server-wide temporary stateShared session
Non-persistent session fieldsSession data
React to changes (server listeners)Server change listeners
React to changes (client listeners)Client change listeners
Migrate old savesMigration

Topic guides ​

Other focused guides (site map) ​

New features get a short entry in What's new first, then deeper pages when needed.

PlayerState - High-Performance Roblox Data Management