@littlepartytime/sdk 2.2.2 → 2.3.0

package/GAME_DEV_GUIDE.md

@@ -23,10 +23,10 @@ my-game/
 ├── vitest.config.ts       # Test configuration
 ├── tsconfig.json
 ├── assets/                # Game images and custom assets
-│   ├── icon.png           # 1:1 (256x256+) - game list icon
-│   ├── banner.png         # 16:9 (640x360+) - lobby banner
-│   ├── cover.png          # 21:9 (840x360+) - store/featured cover
-│   ├── splash.png         # 9:21 (360x840+) - loading screen
+│   ├── icon.png           # 1:1 (512x512+) - game list icon
+│   ├── banner.webp        # 16:9 (1280x720+) - lobby banner
+│   ├── cover.webp         # 21:9 (1260x540+) - store/featured cover
+│   ├── splash.webp        # 9:21 (1080x2520+) - loading screen
 │   ├── cards/             # Custom game assets (optional)
 │   │   ├── king.png
 │   │   └── queen.png
@@ -76,16 +76,18 @@ const config: GameConfig = {
   name: "My Game",           // Display name (Chinese preferred for CN users)
   description: "...",        // Brief description
   assets: {
-    icon: "assets/icon.png",       // 1:1 game list icon
-    banner: "assets/banner.png",   // 16:9 lobby banner
-    cover: "assets/cover.png",     // 21:9 store/featured cover
-    splash: "assets/splash.png",   // 9:21 loading screen
+    icon: "assets/icon.png",        // 1:1 (512x512+), PNG recommended
+    banner: "assets/banner.webp",   // 16:9 (1280x720+), WebP recommended
+    cover: "assets/cover.webp",     // 21:9 (1260x540+), WebP recommended
+    splash: "assets/splash.webp",   // 9:21 (1080x2520+), WebP recommended
   },
   minPlayers: 2,
   maxPlayers: 6,
   tags: ["strategy", "card"],
   version: "1.0.0",
   sdkVersion: "2.0.0",
+  // Optional: include a demo site in the game package
+  // demo: { title: "My Game — Demo" },
 };
 
 export default config;
@@ -430,9 +432,33 @@ Features:
 - **Action log**: See all actions sent by players in real-time
 - **Game over detection**: Automatically detects when `isGameOver()` returns true and displays results
 - **Reset**: Re-initialize the game at any time
+- **Screenshot**: Capture the game content area (without the phone frame) as a PNG file
 
 This enables a rapid development cycle: **edit code -> refresh browser -> test immediately**.
 
+### Screenshot
+
+A **Screenshot** button floats at the bottom of the phone frame on the Preview page. Clicking it captures the game's safe area (390×751 px, 2× retina resolution) as a PNG and downloads it immediately. The phone bezel, Dynamic Island, and Home Indicator are excluded.
+
+The same capture function is also exposed as a JavaScript API on the page, so LLMs and Playwright scripts can call it programmatically:
+
+```javascript
+// Via Playwright evaluate (e.g. in a test or from an AI agent):
+const dataUrl = await page.evaluate(() => window.__devkit__.captureScreen());
+// dataUrl is a "data:image/png;base64,..." string — pass it to a vision model or save it.
+
+// Save to file in Node.js:
+const base64 = dataUrl.replace(/^data:image\/png;base64,/, '');
+fs.writeFileSync('screenshot.png', Buffer.from(base64, 'base64'));
+```
+
+Alternatively, Playwright's built-in element screenshot can target the game area directly using the stable test ID:
+
+```javascript
+const el = page.getByTestId('game-screen');
+await el.screenshot({ path: 'screenshot.png' });
+```
+
 ### Multiplayer Page
 
 The Play page runs your game with real Socket.IO multiplayer:
@@ -535,6 +561,16 @@ await preview.startGame();                // Host clicks "Start Game"
 await preview.stop();                     // Clean up browser + server
 ```
 
+To capture a screenshot of the game area during a test, use either approach:
+
+```typescript
+// Option A: via window.__devkit__ (returns base64 data URL)
+const dataUrl = await page.evaluate(() => window.__devkit__.captureScreen());
+
+// Option B: via Playwright element screenshot (saves directly to file)
+await page.getByTestId('game-screen').screenshot({ path: 'screenshot.png' });
+```
+
 ### Excluding E2E Tests from Unit Test Runs
 
 E2E tests are slower and require playwright. Exclude them from the default `vitest run`:
@@ -572,8 +608,9 @@ This command:
 3. Reads `GameConfig` from the built engine to extract metadata
 4. Validates the required image assets (format, dimensions, aspect ratio)
 5. Validates `rules.md` exists and is non-empty
-6. Generates `manifest.json` from your config
-7. Creates a `.zip` file in the `dist/` directory containing code, manifest, rules, and images
+6. If `GameConfig.demo` is set, validates that `demo/dist/index.html` exists
+7. Generates `manifest.json` from your config
+8. Creates a `.zip` file in the `dist/` directory containing code, manifest, rules, images, and optional demo site
 
 ### Build Output
 
@@ -594,15 +631,17 @@ The `.zip` upload package contains:
 ├── rules.md       # Game rules
 ├── bundle.js      # Client-side bundle
 ├── engine.cjs     # Server-side engine
-├── icon.png       # 1:1 game icon
-├── banner.png     # 16:9 banner
-├── cover.png      # 21:9 cover
-├── splash.png     # 9:21 splash screen
-└── assets/        # Custom game assets (if any)
-    ├── cards/
-    │   └── king.png
-    └── sounds/
-        └── flip.mp3
+├── icon.png|.webp    # 1:1 game icon
+├── banner.png|.webp  # 16:9 banner
+├── cover.png|.webp   # 21:9 cover
+├── splash.png|.webp  # 9:21 splash screen
+├── assets/        # Custom game assets (if any)
+│   ├── cards/
+│   │   └── king.png
+│   └── sounds/
+│       └── flip.mp3
+└── demo/          # Demo site (optional, only if GameConfig.demo is set)
+    └── index.html
 ```
 
 ### Configuration
@@ -657,21 +696,21 @@ export default defineConfig({
 
 Every game must include 4 images in the `assets/` directory. These are validated and packaged by the `pack` command.
 
-| Image | Aspect Ratio | Min Size | Purpose |
-|-------|-------------|----------|---------|
-| `icon.png` | 1:1 | 256x256 | Game list icon |
-| `banner.png` | 16:9 | 640x360 | Lobby banner |
-| `cover.png` | 21:9 | 840x360 | Store/featured cover |
-| `splash.png` | 9:21 | 360x840 | Loading/splash screen |
+| Image | Aspect Ratio | Recommended Size | Purpose |
+|-------|-------------|-----------------|---------|
+| `icon.png` | 1:1 | 512x512 | Game list icon |
+| `banner.png` or `.webp` | 16:9 | 1280x720 | Lobby banner |
+| `cover.png` or `.webp` | 21:9 | 1260x540 | Store/featured cover |
+| `splash.png` or `.webp` | 9:21 | 1080x2520 | Loading/splash screen |
 
 **Rules:**
-- **Formats**: PNG or WebP only
+- **Formats**: PNG or WebP only. Recommendation: use PNG for icon (small, sharp edges), WebP for banner/cover/splash (photo-like content, 60-80% smaller than PNG)
 - **Aspect ratio**: Must match exactly (1% tolerance)
-- **Minimum dimensions**: Must meet or exceed the minimum size
-- **File size**: Warning if any image exceeds 2MB
-- **Paths**: Referenced in `GameConfig.assets` as relative paths from the project root
+- **Dimensions**: Must meet or exceed the recommended size. Exact match preferred; larger with correct ratio also accepted
+- **File size**: Warning if any image exceeds 2MB (WebP typically avoids this even at splash resolution)
+- **Paths**: Referenced in `GameConfig.assets` as relative paths from the project root (e.g., `"assets/banner.webp"`)
 
-The `pack` command reads these images, validates them, and includes them in the zip with canonical names (`icon.png`, `banner.png`, etc.).
+The `pack` command reads these images, validates them, and includes them in the zip with canonical names (`icon`, `banner`, `cover`, `splash`) preserving the original file extension (`.png` or `.webp`).
 
 ### Custom Game Assets
 
@@ -679,10 +718,10 @@ For assets used inside your game UI (card images, sound effects, fonts, etc.), p
 
 ```
 assets/
-├── icon.png          # Platform display images (root level, required)
-├── banner.png
-├── cover.png
-├── splash.png
+├── icon.png          # Platform display images (root level, required, .png or .webp)
+├── banner.webp
+├── cover.webp
+├── splash.webp
 ├── cards/            # Custom game assets (subdirectories)
 │   ├── king.png
 │   └── queen.png
@@ -897,8 +936,39 @@ Use these CSS variables in your inline styles for consistent theming:
 | Border | `--border-default` | `border: "1px solid var(--border-default)"` |
 | Success | `--success` | `color: "var(--success)"` |
 | Error | `--error` | `color: "var(--error)"` |
+| Body font (sans-serif) | `--font-body` | `fontFamily: "var(--font-body)"` |
+| Serif font | `--font-serif` | `fontFamily: "var(--font-serif)"` |
 | Display font | `--font-display` | `fontFamily: "var(--font-display)"` |
-| Body font | `--font-body` | `fontFamily: "var(--font-body)"` |
+
+### Platform Fonts
+
+The platform self-hosts **Noto Sans SC** (sans-serif) and **Noto Serif SC** (serif) via `next/font/google`, available to all games inside the sandbox container.
+
+| CSS Variable | Font | Type |
+|---|---|---|
+| `--font-body` | Noto Sans SC | sans-serif (default — inherited automatically) |
+| `--font-serif` | Noto Serif SC | serif |
+| `--font-display` | Comfortaa | display / title |
+
+Games inherit `--font-body` (Noto Sans SC) by default — no action needed for sans-serif text.
+
+To use the serif font:
+
+```tsx
+<p style={{ fontFamily: "var(--font-serif)" }}>衬线体文本</p>
+```
+
+**Do NOT reference fonts by name.** The platform uses hashed `font-family` names internally, so literal font names will not match the self-hosted font files:
+
+```css
+/* ✅ Works */
+font-family: var(--font-body);
+font-family: var(--font-serif);
+
+/* ❌ Does NOT work — won't match the self-hosted font */
+font-family: 'Noto Sans SC', sans-serif;
+font-family: 'Noto Serif SC', serif;
+```
 
 ## Platform Runtime Constraints
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export type { Player, GameAction, GameResult, Platform, HapticImpactStyle, HapticNotificationType, DeviceTilt, DeviceCapabilities, } from './types';
-export type { PlayerState, GameState, GameAssets, GameConfig, GameEngine, GameRendererProps } from './interfaces';
+export type { PlayerState, GameState, GameAssets, GameDemo, GameConfig, GameEngine, GameRendererProps } from './interfaces';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,UAAU,EACV,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,UAAU,EACV,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,kBAAkB,GACnB,MAAM,SAAS,CAAC;AACjB,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC"}

package/dist/interfaces.d.ts

@@ -9,15 +9,19 @@ export interface GameState {
     data: Record<string, unknown>;
 }
 export interface GameAssets {
-    /** 1:1 game list icon (relative path from project root, .png or .webp) */
+    /** 1:1 game list icon (512x512+ recommended, .png or .webp) */
     icon: string;
-    /** 16:9 lobby banner */
+    /** 16:9 lobby banner (1280x720+ recommended, .png or .webp) */
     banner: string;
-    /** 21:9 store/featured cover */
+    /** 21:9 store/featured cover (1260x540+ recommended, .png or .webp) */
     cover: string;
-    /** 9:21 loading/splash screen */
+    /** 9:21 loading/splash screen (1080x2520+ recommended, .png or .webp) */
     splash: string;
 }
+export interface GameDemo {
+    /** Title shown on the demo page (e.g. "奶酪大盗 — 游戏演示") */
+    title: string;
+}
 export interface GameConfig {
     name: string;
     description: string;
@@ -28,6 +32,8 @@ export interface GameConfig {
     version: string;
     sdkVersion: string;
     price?: number;
+    /** Optional demo site metadata. When present, `lpt-dev-kit pack` will look for `demo/dist/` and include it in the ZIP. */
+    demo?: GameDemo;
 }
 export interface GameEngine {
     init(players: Player[], options?: Record<string, unknown>): GameState;

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACtE,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAChF;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IACxC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC3B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0HAA0H;IAC1H,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACtE,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAChF;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,UAAU,CAAC;IACxC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CAC3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@littlepartytime/sdk",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "Game SDK for Little Party Time platform - type definitions and testing utilities",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",