@playcademy/sandbox 0.1.8 → 0.1.9-alpha.1

package/README.md

@@ -21,7 +21,7 @@ It's a "mock Playcademy platform" running on your machine that behaves just like
 - **Zero Configuration**: Automatic database setup and seeding.
 - **Full API Compatibility**: All Playcademy APIs available locally.
 - **Integrated Real-time Server**: Built-in WebSocket server for multiplayer features.
-- **Fast Development Cycle**: Quick startup with an in-memory database.
+- **Fast Development Cycle**: Quick startup with persistent local database.
 
 ## How It Works
 
@@ -33,7 +33,7 @@ graph TD
         A["Your Game (in browser)"] --> B["@playcademy/sdk"];
         B --> C["API Server (localhost:4321)"];
         B --> D["Real-time Server (localhost:4322)"];
-        C --> E["In-Memory Database"];
+        C --> E["Local PGlite Database"];
         D --> E;
     end
 ```
@@ -160,13 +160,13 @@ const client = await PlaycademyClient.init({
 
 ## Sandbox Features
 
-| Feature              | Description                                                                                   |
-| :------------------- | :-------------------------------------------------------------------------------------------- |
-| **API Simulation**   | Emulates the entire Playcademy backend API for users, games, inventory, etc.                  |
-| **Real-time Server** | Provides WebSocket-based real-time channels for multiplayer communication.                    |
-| **Data Persistence** | Uses an in-memory database. Data persists until the sandbox is restarted.                     |
-| **Mock Data**        | Automatically seeds with a mock user (`developer@example.com`) and other demo data.           |
-| **Game Context**     | When run via the Vite plugin, it automatically registers your current project as a mock game. |
+| Feature              | Description                                                                                                           |
+| :------------------- | :-------------------------------------------------------------------------------------------------------------------- |
+| **API Simulation**   | Emulates the entire Playcademy backend API for users, games, inventory, etc.                                          |
+| **Real-time Server** | Provides WebSocket-based real-time channels for multiplayer communication.                                            |
+| **Data Persistence** | Persists data to disk by default (survives restarts). Use `--recreate-db` to reset, or `--memory` for in-memory only. |
+| **Mock Data**        | Automatically seeds with demo users and data on first run or when database is empty.                                  |
+| **Game Context**     | When run via the Vite plugin, it automatically registers your current project as a mock game.                         |
 
 ## Server Endpoints
 
@@ -332,17 +332,17 @@ This should return a JSON object with the status:
 | **API calls return HTML**      | This indicates the API server isn't running or is on a different port. Check your sandbox `url` configuration.                                                |
 | **WebSocket connection fails** | Verify the real-time server is enabled (`--realtime` flag or Vite config) and check its port in the console output.                                           |
 | **Port conflicts**             | Use the `--port` and `--realtime-port` options to choose different ports. The sandbox will automatically try the next available port if its default is taken. |
-| **Data doesn't persist**       | This is expected. The sandbox uses an in-memory database that resets on every restart to ensure a clean state for development.                                |
+| **Data persists unexpectedly** | By default, the sandbox persists data to disk. Use `--recreate-db` to reset the database, or `--memory` for session-only data that doesn't persist.           |
 
 ## Production vs. Sandbox
 
 The SDK is designed to work seamlessly in both environments. `PlaycademyClient.init()` automatically detects whether it's running in a production environment or against a local sandbox.
 
-| Feature            | Sandbox         | Production            |
-| :----------------- | :-------------- | :-------------------- |
-| **Data**           | Mock, temporary | Real user data        |
-| **Authentication** | Mock tokens     | Secure authentication |
-| **Persistence**    | Session only    | Permanent             |
+| Feature            | Sandbox                                           | Production               |
+| :----------------- | :------------------------------------------------ | :----------------------- |
+| **Data**           | Mock, temporary                                   | Real user data           |
+| **Authentication** | Mock tokens                                       | Secure authentication    |
+| **Persistence**    | Local disk (default) or session-only (`--memory`) | Permanent cloud database |
 
 ## Contributing
 

package/dist/cli.d.ts

@@ -1,2 +1 @@
 #!/usr/bin/env node
-export {};