PlayerStateType-safe player data for Roblox

ProfileStore persistence, Replica sync, path-based access, and a server-authoritative model built for serious games.

Get Started

View API

Concepts

🧩

Type safety

TypeScript-style annotations and structured paths across server and client.

⚡

Real-time sync

Replica-backed updates so clients stay current without bespoke networking.

💾

Persistence

ProfileStore integration for saves, sessions, shutdown, and reconcile-friendly defaults.

📍

Paths & nesting

Dot-notation helpers for nested tables without manual deep copies everywhere.

📡

Change listeners

Subscribe to updates for UI, gameplay systems, or analytics pipelines.

📦

Collections

Helpers for arrays and dictionaries so gameplay code stays terse and consistent.

🌐

Shared session

Server-wide temporary state replicated to every client via SharedSession.

🔐

Server-only roots

Saved per-player fields stripped before the client Replica via ServerOnlyRoots.

Created by bellaouzo — Powerful player data tooling that pairs ProfileStore with Replica replication.

Use a Server root and ServerOnlyRoots when data should persist but never reach any client Replica. Server-only player data · Data visibility model

Getting started

Quick start — Minimal server Init and client read/OnChanged
Installation — Creator Store model, folder layout, require paths
Setup and Configuration — DefaultData, saves, and PlayerStateConfig
Concepts · API reference · Examples

Ready to go

The Roblox model ships with ProfileStore and Replica — use Get Model in the nav or Installation.

Performance overview

Get: 2.2M/secSet: 478K/secGetPath: 2.1M/secSetPath: 488K/sec

Looking for a specific task? Use the “I want to…” shortcuts on the Guides hub.

See What's new for migrations, Shared Session, server-only roots, session data, and other highlights.

If you have existing player data, Legacy Data Migration can import from an old DataStore during profile load (opt-in).

Optional support — This documentation is free. You do not need to pay anything to use PlayerState or these docs. If you would like to leave a tip, it is genuinely appreciated, but completely optional and never expected.

In PayPal, use Send and enter joelbriskpro@gmail.com. Open PayPal