@playcademy/vite-plugin 0.0.1-beta.2 → 0.0.1-beta.5

package/README.md

@@ -30,12 +30,18 @@ import { playcademy } from '@playcademy/vite-plugin'
 export default defineConfig({
     plugins: [
         playcademy({
-            // Optional: configure plugin options here
-            // bootMode: 'direct',
-            // entryPoint: 'my-game.html',
-            // styles: ['src/main.css'],
-            // engine: 'phaser',
-            // autoZip: true, // Set to true to enable zipping locally
+            export: {
+                // bootMode: 'iframe',
+                // entryPoint: 'my-game.html',
+                // styles: ['src/main.css'],
+                // platform: 'web',
+                // autoZip: true, // Set to true to enable zipping locally
+            },
+            sandbox: {
+                // autoStart: true, // Auto-start sandbox during development
+                // url: 'http://localhost:4321/api', // Custom sandbox URL
+                // verbose: true, // Enable verbose logging from sandbox
+            },
         }),
     ],
     // ...other Vite config
@@ -44,19 +50,26 @@ export default defineConfig({
 
 ## What it does
 
-1.  **Generates `playcademy.manifest.json`**:
+1.  **Auto-starts Development Sandbox**:
+    During development (`vite dev`), the plugin automatically starts a local Playcademy sandbox server that provides game APIs for testing. This allows you to develop your game locally with full API integration.
+
+2.  **Generates `playcademy.manifest.json`**:
     This file is created in your Vite build's output directory (`dist` by default). It contains metadata about your game, such as its entry point, boot mode, and engine type, which is used by the Playcademy platform.
 
-2.  **Creates Output Zip Archive (Optional)**:
+3.  **Creates Output Zip Archive (Optional)**:
     If `autoZip` is enabled, the plugin will create a zip file named `{your-project-name}.zip` inside a `.playcademy` directory at the root of your project (e.g., `my-game/.playcademy/my-game.zip`).
     This archive contains all the contents of your build output directory and can be uploaded directly to the Playcademy platform.
 
-3.  **Sets Vite `base` Configuration (if not set by user)**:
+4.  **Sets Vite `base` Configuration (if not set by user)**:
     The plugin defaults Vite's `base` configuration to `'./'`. This is necessary for games to correctly reference assets when deployed on the Playcademy platform. If you explicitly set a `base` path in your `vite.config.ts`, the plugin will respect your configuration and not override it.
 
 ## Options (`PlaycademyPluginOptions`)
 
-The `playcademy()` plugin function accepts an optional options object:
+The `playcademy()` plugin accepts an optional options object with two main namespaces:
+
+### Export Options (`export`)
+
+Configuration for manifest generation and build output:
 
 - **`bootMode`**:
 
@@ -76,10 +89,10 @@ The `playcademy()` plugin function accepts an optional options object:
     - Default: `[]`
     - An array of CSS file paths (relative to the project root) that should be loaded by the Playcademy platform.
 
-- **`engine`**:
+- **`platform`**:
 
-    - Type: `'three' | 'phaser' | 'godot' | 'unity' | 'custom'`
-    - Default: `'custom'`
+    - Type: `'web' | 'godot' | 'unity'`
+    - Default: `'web'`
     - Specifies the game engine used.
 
 - **`autoZip`**:
@@ -87,6 +100,27 @@ The `playcademy()` plugin function accepts an optional options object:
     - Default: `false`
     - Controls whether to automatically create a zip archive of the build output.
 
+### Sandbox Options (`sandbox`)
+
+Configuration for the development sandbox server:
+
+- **`autoStart`**:
+
+    - Type: `boolean`
+    - Default: `true`
+    - Controls whether to automatically start the development sandbox during `vite dev`.
+
+- **`url`**:
+
+    - Type: `string`
+    - Default: `'http://localhost:4321/api'`
+    - The URL of the sandbox server to use (useful if you're running your own sandbox instance).
+
+- **`verbose`**:
+    - Type: `boolean`
+    - Default: `false`
+    - Enables verbose logging from the sandbox server and API handlers for debugging.
+
 ## Development
 
 To install dependencies for this package:

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Playcademy Vite Plugin
+ *
+ * Provides:
+ * - Auto-starting sandbox server during development
+ * - Hijacking dev server to serve Playcademy loader environment
+ * - Build-time manifest generation and optional zip packaging
+ */
+import type { Plugin } from 'vite';
+import type { ManifestV1 } from '@playcademy/types';
+export interface PlaycademyExportOptions {
+    bootMode?: ManifestV1['bootMode'];
+    entryPoint?: string;
+    styles?: string[];
+    platform?: ManifestV1['platform'];
+    autoZip?: boolean;
+}
+export interface PlaycademySandboxOptions {
+    autoStart?: boolean;
+    url?: string;
+    verbose?: boolean;
+}
+export interface PlaycademyPluginOptions {
+    export?: PlaycademyExportOptions;
+    sandbox?: PlaycademySandboxOptions;
+}
+export declare function playcademy(options?: PlaycademyPluginOptions): Plugin;