@littlepartytime/sdk 2.2.0 → 2.2.2

package/GAME_DEV_GUIDE.md

@@ -253,12 +253,12 @@ export default function GameRenderer({ platform, state }: GameRendererProps) {
     [platform]
   );
 
-  // Render game UI
+  // Render game UI — use inline styles + CSS variables for consistent styling
   return (
-    <div>
+    <div style={{ color: "var(--text-primary)" }}>
       {/* Your game UI here */}
-      {/* Use Tailwind CSS classes - the platform provides Tailwind */}
-      {/* Use the design tokens from the platform: bg-bg-primary, text-accent, etc. */}
+      {/* Use inline styles with CSS variables from the platform design tokens */}
+      {/* See "Renderer Styling Guide" section below for details */}
     </div>
   );
 }
@@ -724,7 +724,7 @@ export default function GameRenderer({ platform, state }: GameRendererProps) {
 | Approach | When to Use | How |
 |----------|-------------|-----|
 | **Inline in bundle** | Tiny assets (< 4KB) | Vite automatically inlines as data URLs |
-| **CSS/SVG** | UI elements, icons | Tailwind CSS utilities or inline SVG components |
+| **CSS/SVG** | UI elements, icons | Inline styles, `<style>` injection, or inline SVG components |
 | **Emoji/Unicode** | Simple visual indicators | Unicode characters directly in JSX |
 
 > **Tip:** Use `platform.getAssetUrl()` for assets 100KB+ instead of inlining them into the bundle.
@@ -822,30 +822,83 @@ interface PlayerState {
 
 ### Renderer Rules
 1. **React functional component**: Use hooks, not class components.
-2. **Tailwind CSS only**: Use the platform's design tokens for consistent styling.
+2. **Inline styles + `<style>` injection**: Do NOT use Tailwind CSS (see "Renderer Styling Guide" below). Use inline styles with CSS variables for layout and theming. Use `<style>` injection for animations and pseudo-classes.
 3. **Mobile-first**: Design for phone screens (375px width). The platform is a PWA.
 4. **No direct socket access**: Only use `platform.send()` and `platform.on()`.
 5. **Chinese UI text**: The platform targets Chinese-speaking users.
 6. **Responsive touch targets**: Buttons should be at least 44x44px for mobile.
 
+### Renderer Styling Guide
+
+**Do NOT use Tailwind CSS in game renderers.** The production platform pre-compiles Tailwind at build time and only scans the platform's own source code — game bundles are loaded dynamically at runtime, so Tailwind utility classes (especially arbitrary values like `w-[280px]`, `text-[18px]`) will silently fail in production even though they work in the dev-kit.
+
+Use **inline styles** as the primary styling method, with **`<style>` injection** for features that inline styles can't express (animations, pseudo-classes, hover states).
+
+#### Inline styles (primary)
+
+```tsx
+// ✅ Use inline styles with CSS variables
+<div style={{ width: 280, height: 60, fontSize: 18, color: "var(--text-primary)" }}>
+
+// ❌ Do NOT use Tailwind classes
+<div className="w-[280px] h-[60px] text-[18px] text-text-primary">
+```
+
+#### `<style>` injection (for animations and pseudo-classes)
+
+```tsx
+const GameStyles = () => (
+  <style>{`
+    @keyframes card-flip {
+      0% { transform: rotateY(0deg); }
+      50% { transform: rotateY(90deg); scale: 1.1; }
+      100% { transform: rotateY(180deg); }
+    }
+    .my-game-card-flip { animation: card-flip 0.6s ease-in-out; }
+    .my-game-btn:disabled { opacity: 0.4; }
+    .my-game-input:focus { outline: none; border-color: var(--accent-primary); }
+  `}</style>
+);
+
+export default function GameRenderer({ platform, state }: GameRendererProps) {
+  return (
+    <div>
+      <GameStyles />
+      <div className="my-game-card-flip" style={{ width: 120, height: 180 }}>
+        {/* card content */}
+      </div>
+    </div>
+  );
+}
+```
+
+> **Tip:** Prefix your CSS class names with your game name (e.g., `my-game-`) to avoid conflicts when multiple games coexist.
+
+#### Why this approach
+
+- **Zero dependencies**: No CSS framework needed
+- **Consistent across environments**: Inline styles work identically in dev-kit and production
+- **No conflicts**: Inline styles are naturally isolated; multiple games won't interfere
+- **More flexible animations**: Native CSS keyframes support multi-stage animations, cubic-bezier curves, and staggered delays — more powerful than Tailwind's preset `animate-*` classes
+
 ### Design Token Reference
 
-Use these CSS variables / Tailwind classes for consistent styling:
-
-| Purpose | CSS Variable | Tailwind Class |
-|---------|-------------|----------------|
-| Page background | `--bg-primary` | `bg-bg-primary` |
-| Card background | `--bg-secondary` | `bg-bg-secondary` |
-| Elevated surface | `--bg-tertiary` | `bg-bg-tertiary` |
-| Primary accent | `--accent-primary` | `text-accent` / `bg-accent` |
-| Primary text | `--text-primary` | `text-text-primary` |
-| Secondary text | `--text-secondary` | `text-text-secondary` |
-| Muted text | `--text-tertiary` | `text-text-tertiary` |
-| Border | `--border-default` | `border-border-default` |
-| Success | `--success` | `text-success` |
-| Error | `--error` | `text-error` |
-| Display font | `--font-display` | `font-display` |
-| Body font | `--font-body` | `font-body` |
+Use these CSS variables in your inline styles for consistent theming:
+
+| Purpose | CSS Variable | Inline Style Example |
+|---------|-------------|---------------------|
+| Page background | `--bg-primary` | `background: "var(--bg-primary)"` |
+| Card background | `--bg-secondary` | `background: "var(--bg-secondary)"` |
+| Elevated surface | `--bg-tertiary` | `background: "var(--bg-tertiary)"` |
+| Primary accent | `--accent-primary` | `color: "var(--accent-primary)"` |
+| Primary text | `--text-primary` | `color: "var(--text-primary)"` |
+| Secondary text | `--text-secondary` | `color: "var(--text-secondary)"` |
+| Muted text | `--text-tertiary` | `color: "var(--text-tertiary)"` |
+| Border | `--border-default` | `border: "1px solid var(--border-default)"` |
+| Success | `--success` | `color: "var(--success)"` |
+| Error | `--error` | `color: "var(--error)"` |
+| Display font | `--font-display` | `fontFamily: "var(--font-display)"` |
+| Body font | `--font-body` | `fontFamily: "var(--font-body)"` |
 
 ## Platform Runtime Constraints
 
@@ -982,6 +1035,101 @@ Renderer receives "stateUpdate" event with filtered state
 React re-renders with new state
 ```
 
+## Game Settlement Lifecycle
+
+When `isGameOver()` returns `true`, the platform **immediately** takes over: it sends `game:result` to all clients, transitions to the settlement screen, and **unloads the game renderer**. This happens in the same tick as the final `game:state` broadcast:
+
+```
+engine.handleAction(state, playerId, action) → newState
+broadcastPlayerViews(newState)          ← last game frame sent
+engine.isGameOver(newState) → true
+handleGameEnd()                         ← platform takes over, renderer unloaded
+```
+
+If your game needs an in-game settlement screen (animations, rankings, replay, etc.), you **must not** let `isGameOver()` return `true` until that screen is done.
+
+### Two-Phase Settlement Pattern
+
+Split game ending into two phases:
+
+```
+playing → (winner decided) → settlement → (player confirms or timer expires) → finished
+                               ↑                                                  ↑
+                        isGameOver = false                                 isGameOver = true
+                        game renderer shows                                platform takes over
+                        its own result screen
+```
+
+#### Engine Implementation
+
+```typescript
+handleAction(state: GameState, playerId: string, action: GameAction): GameState {
+  const data = state.data as MyGameData;
+
+  // 1. Normal gameplay — when winner is decided, enter settlement
+  if (state.phase === "playing" && winnerDecided(data)) {
+    return {
+      ...state,
+      phase: "settlement",
+      data: { ...data, rankings: computeRankings(data) },
+    };
+  }
+
+  // 2. Settlement — wait for confirm action, then finish
+  if (state.phase === "settlement" && action.type === "CONFIRM_RESULT") {
+    return { ...state, phase: "finished" };
+  }
+
+  return state;
+},
+
+isGameOver(state: GameState): boolean {
+  return state.phase === "finished";   // NOT "settlement"!
+},
+
+getPlayerView(state: GameState, playerId: string): Partial<GameState> {
+  if (state.phase === "settlement") {
+    // Return rankings / stats for the in-game result screen
+    return {
+      ...state,
+      data: { rankings: (state.data as MyGameData).rankings },
+    };
+  }
+  // ...
+},
+```
+
+#### Renderer Implementation
+
+```tsx
+export default function GameRenderer({ platform, state }: GameRendererProps) {
+  if (state.phase === "settlement") {
+    return (
+      <div>
+        {/* Show your in-game result screen here */}
+        <Rankings data={state.data.rankings} />
+        <button onClick={() => platform.send({ type: "CONFIRM_RESULT" })}>
+          确认
+        </button>
+      </div>
+    );
+  }
+  // ... normal gameplay UI
+}
+```
+
+### Common Mistakes
+
+| Mistake | Consequence |
+|---------|------------|
+| `isGameOver()` returns `true` in `settlement` phase | In-game result screen is skipped — platform unloads the renderer immediately |
+| No `settlement` phase; jumping straight from `playing` to `finished` | Players never see the in-game result animation / ranking |
+| Calling `platform.reportResult()` from the renderer | No-op — settlement is driven entirely by the server via `isGameOver` + `getResult` |
+
+### One-Liner Rule
+
+> **`isGameOver()` is the platform takeover switch. Do not return `true` until your in-game result screen is done.**
+
 ## Complete Example: Number Guessing Game
 
 See the [`examples/number-guess`](../../examples/number-guess) directory for a complete working example.

package/dist/interfaces.d.ts

@@ -32,6 +32,16 @@ export interface GameConfig {
 export interface GameEngine {
     init(players: Player[], options?: Record<string, unknown>): GameState;
     handleAction(state: GameState, playerId: string, action: GameAction): GameState;
+    /**
+     * Called after every handleAction. When this returns true, the platform
+     * immediately sends game:result, unloads the renderer, and shows the
+     * platform settlement screen.
+     *
+     * If your game has an in-game result screen (animations, rankings, etc.),
+     * keep returning false during that phase and only return true when the
+     * in-game result screen is done. See "Game Settlement Lifecycle" in
+     * GAME_DEV_GUIDE.md.
+     */
     isGameOver(state: GameState): boolean;
     getResult(state: GameState): GameResult;
     getPlayerView(state: GameState, playerId: string): Partial<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,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,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"}

package/package.json

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