Skip to content

PaoPao's DataStore Module (PPDS)

PPDS is a high-performance Roblox DataStore wrapper that simplifies the management of persistent data with advanced caching, cross-server synchronization, and migration capabilities. It is designed to be robust, efficient, and developer-friendly, allowing you to focus on creating engaging gameplay experiences without worrying about the complexities of data storage.

Features

  • Global Shared Cache: Data is cached across all server instances, ensuring consistency and reducing DataStore calls.
  • Cross-Server Locking: Prevents data corruption from concurrent writes across multiple servers using MemoryStoreService.
  • Automatic Data Migrations: Seamlessly update your data structure over time without losing player data.
  • Event-Driven Architecture: Integrate with your game logic using OnInit, OnSave, OnDelete, and OnInvalidate events.
  • Robust Error Handling: Built-in exponential backoff retry logic for DataStore operations.
  • Session Management: Efficiently handle player data loading, saving, and cleanup.
  • Development Tools: Export/import cache snapshots for debugging and testing.

How it work (not full details yet)

graph TD
    %% Requests
    A[Server Request] --> B(PPDS: init / get / set / update / increment / leave)

    %% Cache Flow
    B --> C{Cache Hit?}
    C -- Yes --> D[Return Cached Data]
    C -- No --> E[Read from DataStore]

    %% DataStore Success Path
    E --> F{DataStore Success?}
    F -- Yes --> G[Update Cache]
    G --> D

    %% DataStore Failure Path
    F -- No --> H[Retry with Exponential Backoff]
    H -- Success --> G
    H -- Failure --> I[Error Handling]

    %% Event Propagation
    D --> J[Trigger Events: OnSave / OnInit / OnDelete]
    J --> K[Cross-Server Sync / Invalidation]
    K --> L[Other Servers / Clients]

    %% Async Write Path
    B -- set / update / increment --> M[Queue for Async Write]
    M --> N[DataStore Write Batching]
    N --> O[DataStore Save]
    O -- Success --> P[Trigger OnSave Event]
    O -- Failure --> Q[Retry / Error Handling]

    class C,D,G cache;
    class E,F,H,O,N datastore;
    class J,K,L,P events;
    class M,Q async;

Quick Start

To get started with PPDS, check out the detailed documentation and tutorials:

Getting Started Guide API Reference

License

PPDS is released under the Apache License 2.0. This permissive license allows you to use, modify, and distribute PPDS in both personal and commercial projects.

See the LICENSE file for complete details.

Note from (solo) Dev

note 1 (Important)

sub-note 1

PPDS represents a production-ready DataStore solution with enterprise features. While the API is stable, we continuously improve performance and add features based on community feedback.

sub-note 2 (A Very Important!)

some api changes may occur in the future, so please check back regularly for updates, not 100% guaranteed that the api will not change, but i will try to keep it stable.

sub-note 3

If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository but good /w pull request and bug fixes in pull request.

lol Funny Cat