create-smore-game 2.1.0 → 2.3.0

package/README.md

@@ -0,0 +1,159 @@
+# create-smore-game
+
+Scaffold a multiplayer party game for the S'MORE platform.
+
+---
+
+## Quick Start
+
+```bash
+npx create-smore-game my-game
+cd my-game
+npm install
+npm run dev
+```
+
+The CLI prompts you for two choices:
+
+```
+  create-smore-game
+
+  Screen (TV) template:
+    React + Phaser
+    React only
+    Vanilla JS
+
+  Controller (phone) template:
+    React
+    Vanilla JS
+```
+
+After answering, your project is ready to run.
+
+---
+
+## What You Get
+
+```
+my-game/
+├── screen/                    # TV/display — game logic lives here
+│   ├── src/
+│   │   ├── App.tsx            # Main game component
+│   │   └── __tests__/         # Game tests with vitest
+│   ├── package.json
+│   └── vite.config.ts
+├── controller/                # Phone/player input — stateless display + input
+│   ├── src/
+│   │   ├── App.tsx            # Controller UI
+│   │   └── __tests__/         # Controller tests
+│   ├── package.json
+│   └── vite.config.ts
+├── dev/
+│   ├── server.js              # Local dev server with Socket.IO
+│   ├── harness.html           # Test screen + controllers together
+│   └── controller-page.html
+├── game.json                  # Game metadata (title, player count, etc.)
+├── .env.example
+└── package.json               # npm workspaces root
+```
+
+---
+
+## Development
+
+### Commands
+
+| Command | Description |
+|---|---|
+| `npm run dev` | Start dev server (screen + controller + harness) |
+| `npm run dev:screen` | Screen only |
+| `npm run dev:controller` | Controller only |
+| `npm run build` | Production build |
+| `npm run zip` | Build + package as `game.zip` for deployment |
+
+### Dev Harness
+
+Running `npm run dev` starts a local Socket.IO server and opens a harness page with the screen and one or more controller iframes side by side. You can add and remove players directly in the browser to test the full game flow without a real device.
+
+---
+
+## Architecture: Stateless Controller Pattern
+
+S'MORE games follow a strict separation of concerns:
+
+- **Screen (TV)** — owns all game state and logic. It is the single source of truth.
+- **Controller (Phone)** — a stateless input device. It only renders what the Screen tells it to render, and only sends raw user input back.
+
+```
+Screen  →  "Show vote UI with options A, B, C"  →  Controller renders buttons
+Controller  →  "Player tapped A"  →  Screen processes vote, updates state
+Screen  →  "Show results: A won"  →  Controller renders results
+```
+
+This pattern keeps game logic centralized and makes controllers trivially simple to implement. For full API details, see the `@smoregg/sdk` documentation.
+
+---
+
+## Templates
+
+### Screen Templates
+
+| Template | Best for |
+|---|---|
+| **React + Phaser** | Graphics-heavy games — sprites, animations, physics |
+| **React** | UI-based games — cards, voting, text prompts |
+| **Vanilla JS** | Minimal projects with no framework dependency |
+
+### Controller Templates
+
+| Template | Best for |
+|---|---|
+| **React** | Recommended for most games |
+| **Vanilla JS** | Lightweight alternative |
+
+---
+
+## Game Metadata
+
+`game.json` at the project root describes your game to the S'MORE platform:
+
+```json
+{
+  "id": "my-game",
+  "title": "My Game",
+  "description": "",
+  "version": "0.1.0",
+  "minPlayers": 2,
+  "maxPlayers": 8,
+  "categories": ["party"]
+}
+```
+
+Edit this file before submitting. The `id` must be unique and contain only lowercase letters, numbers, and hyphens.
+
+---
+
+## Building and Deploying
+
+```bash
+npm run zip
+```
+
+This builds both the screen and controller workspaces, copies `game.json` into the output, and packages everything as `game.zip`. Submit this file to the S'MORE platform to deploy your game.
+
+---
+
+## SDK Documentation
+
+The scaffolded project uses `@smoregg/sdk` for all platform communication. See the SDK package for the full API reference, including:
+
+- Connecting screen and controller
+- Sending and receiving typed events
+- Managing player sessions
+- Testing utilities (`createMockScreen`, `createMockController`)
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-smore-game",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "type": "module",
   "bin": {
     "create-smore-game": "./index.js"

package/templates.js

@@ -3,7 +3,7 @@
 // pnpm-workspace.yaml is no longer generated.
 // npm workspaces are configured in root package.json instead.
 
-const SDK_VERSION = '^2.1.0';
+const SDK_VERSION = '^2.3.0';
 
 export function rootPackageJson(name) {
   return JSON.stringify(
@@ -35,6 +35,160 @@ export function envExample() {
 `;
 }
 
+// ─── Test file templates ───
+
+export function screenTestFile() {
+  return `import { describe, it, expect, beforeEach } from 'vitest';
+import { createMockScreen } from '@smoregg/sdk/testing';
+import type { GameEvents } from '../App';
+
+describe('Game Screen', () => {
+  let screen: ReturnType<typeof createMockScreen<GameEvents>>;
+
+  beforeEach(() => {
+    screen = createMockScreen<GameEvents>({ autoReady: true });
+  });
+
+  it('should broadcast score-update when player taps', async () => {
+    await screen.ready;
+
+    // Simulate a tap from player 0
+    screen.simulateEvent('tap', 0, { timestamp: Date.now() });
+
+    // Verify the screen would broadcast the score
+    // (Your game logic goes here)
+  });
+
+  it('should handle player reconnection', async () => {
+    await screen.ready;
+
+    // Simulate player reconnect
+    screen.simulateControllerReconnect(0);
+
+    // In a stateless controller pattern, Screen should re-push
+    // the current view state to the reconnecting controller
+  });
+});
+`;
+}
+
+export function controllerTestFile() {
+  return `import { describe, it, expect, beforeEach } from 'vitest';
+import { createMockController } from '@smoregg/sdk/testing';
+import type { GameEvents } from '../App';
+
+describe('Game Controller', () => {
+  let controller: ReturnType<typeof createMockController<GameEvents>>;
+
+  beforeEach(() => {
+    controller = createMockController<GameEvents>({ autoReady: true });
+  });
+
+  it('should send tap event on user input', async () => {
+    await controller.ready;
+
+    controller.send('tap', { timestamp: Date.now() });
+
+    const sends = controller.getSends();
+    expect(sends).toHaveLength(1);
+    expect(sends[0].event).toBe('tap');
+  });
+
+  it('should update display when Screen pushes score', async () => {
+    await controller.ready;
+
+    // Simulate Screen pushing a score update
+    controller.simulateEvent('score-update', { score: 42 });
+
+    // Your rendering logic would update based on this event
+  });
+});
+`;
+}
+
+export function screenTestFileVanilla() {
+  return `import { describe, it, beforeEach } from 'vitest';
+import { createMockScreen } from '@smoregg/sdk/testing';
+
+interface GameEvents {
+  // Screen → Controller (view state)
+  'score-update': { score: number };
+  'personal-message': { text: string };
+  // Controller → Screen (input)
+  'tap': { timestamp: number };
+}
+
+describe('Game Screen', () => {
+  let screen: ReturnType<typeof createMockScreen<GameEvents>>;
+
+  beforeEach(() => {
+    screen = createMockScreen<GameEvents>({ autoReady: true });
+  });
+
+  it('should broadcast score-update when player taps', async () => {
+    await screen.ready;
+
+    // Simulate a tap from player 0
+    screen.simulateEvent('tap', 0, { timestamp: Date.now() });
+
+    // Verify the screen would broadcast the score
+    // (Your game logic goes here)
+  });
+
+  it('should handle player reconnection', async () => {
+    await screen.ready;
+
+    // Simulate player reconnect
+    screen.simulateControllerReconnect(0);
+
+    // In a stateless controller pattern, Screen should re-push
+    // the current view state to the reconnecting controller
+  });
+});
+`;
+}
+
+export function controllerTestFileVanilla() {
+  return `import { describe, it, expect, beforeEach } from 'vitest';
+import { createMockController } from '@smoregg/sdk/testing';
+
+interface GameEvents {
+  // Screen → Controller (view state)
+  'score-update': { score: number };
+  'personal-message': { text: string };
+  // Controller → Screen (input)
+  'tap': { timestamp: number };
+}
+
+describe('Game Controller', () => {
+  let controller: ReturnType<typeof createMockController<GameEvents>>;
+
+  beforeEach(() => {
+    controller = createMockController<GameEvents>({ autoReady: true });
+  });
+
+  it('should send tap event on user input', async () => {
+    await controller.ready;
+
+    controller.send('tap', { timestamp: Date.now() });
+
+    const sends = controller.getSends();
+    expect(sends).toHaveLength(1);
+    expect(sends[0].event).toBe('tap');
+  });
+
+  it('should update display when Screen pushes score', async () => {
+    await controller.ready;
+
+    // Simulate Screen pushing a score update
+    controller.simulateEvent('score-update', { score: 42 });
+
+    // Your rendering logic would update based on this event
+  });
+});
+`;
+}
+
 // ─── Screen templates ───
 
 const screenTsconfig = JSON.stringify(
@@ -130,6 +284,7 @@ export function screenReactPhaser(gameId) {
         scripts: {
           dev: "vite",
           build: "tsc && vite build",
+          test: "vitest run",
         },
         dependencies: {
           react: "^18.3.1",
@@ -143,6 +298,7 @@ export function screenReactPhaser(gameId) {
           "@vitejs/plugin-react": "^4.3.0",
           typescript: "^5.5.0",
           vite: "^5.4.0",
+          vitest: "^1.6.0",
         },
       },
       null,
@@ -163,8 +319,10 @@ import Phaser from 'phaser';
 import { GameScene } from './scenes/GameScene';
 
 interface GameEvents {
+  // Screen → Controller (view state)
   'score-update': { score: number };
   'personal-message': { text: string };
+  // Controller → Screen (input)
   'tap': { timestamp: number };
 }
 
@@ -185,6 +343,7 @@ export function App() {
   const gameRef = useRef<Phaser.Game | null>(null);
   const [roomCode, setRoomCode] = useState('');
   const [controllers, setControllers] = useState<ControllerInfo[]>([]);
+  const [tapCount, setTapCount] = useState(0);
 
   useEffect(() => {
     let mounted = true;
@@ -238,6 +397,12 @@ export function App() {
       console.log('Player', playerIndex, 'tapped:', data);
       // Forward input to Phaser scene
       gameRef.current?.events.emit('player-tap', { playerIndex, ...data });
+      // Broadcast updated score back to controllers (Screen is source of truth)
+      setTapCount((prev) => {
+        const newCount = prev + 1;
+        screen.broadcast('score-update', { score: newCount });
+        return newCount;
+      });
     });
 
     return () => {
@@ -305,6 +470,7 @@ export class GameScene extends Phaser.Scene {
   }
 }
 `,
+    "src/__tests__/game.test.ts": screenTestFile(),
   };
 }
 
@@ -321,6 +487,7 @@ export function screenReact(gameId) {
         scripts: {
           dev: "vite",
           build: "tsc && vite build",
+          test: "vitest run",
         },
         dependencies: {
           react: "^18.3.1",
@@ -333,6 +500,7 @@ export function screenReact(gameId) {
           "@vitejs/plugin-react": "^4.3.0",
           typescript: "^5.5.0",
           vite: "^5.4.0",
+          vitest: "^1.6.0",
         },
       },
       null,
@@ -351,8 +519,10 @@ import type { Screen, ControllerInfo, GameResults } from '@smoregg/sdk';
 import { useEffect, useRef, useState } from 'react';
 
 interface GameEvents {
+  // Screen → Controller (view state)
   'score-update': { score: number };
   'personal-message': { text: string };
+  // Controller → Screen (input)
   'tap': { timestamp: number };
 }
 
@@ -373,6 +543,7 @@ export function App() {
   const [roomCode, setRoomCode] = useState('');
   const [controllers, setControllers] = useState<ControllerInfo[]>([]);
   const [taps, setTaps] = useState<{ playerIndex: number; time: number }[]>([]);
+  const [tapCount, setTapCount] = useState(0);
 
   useEffect(() => {
     let mounted = true;
@@ -419,6 +590,12 @@ export function App() {
     screen.on('tap', (playerIndex, data) => {
       if (!mounted) return;
       setTaps((prev) => [...prev.slice(-9), { playerIndex, time: Date.now() }]);
+      // Broadcast updated score back to controllers (Screen is source of truth)
+      setTapCount((prev) => {
+        const newCount = prev + 1;
+        screen.broadcast('score-update', { score: newCount });
+        return newCount;
+      });
     });
 
     return () => {
@@ -428,11 +605,6 @@ export function App() {
     };
   }, []);
 
-  // Example: send score update to all players
-  const handleBroadcastScore = () => {
-    screenRef.current?.broadcast('score-update', { score: 100 });
-  };
-
   // Example: send to specific player
   const handleSendToPlayer = (playerIndex: number) => {
     screenRef.current?.sendToController(playerIndex, 'personal-message', { text: 'Hello!' });
@@ -470,6 +642,7 @@ export function App() {
   );
 }
 `,
+    "src/__tests__/game.test.ts": screenTestFile(),
   };
 }
 
@@ -486,6 +659,7 @@ export function screenVanilla(gameId) {
         scripts: {
           dev: "vite",
           build: "tsc && vite build",
+          test: "vitest run",
         },
         dependencies: {
           "@smoregg/sdk": SDK_VERSION, // TODO: auto-detect or update on release
@@ -493,6 +667,7 @@ export function screenVanilla(gameId) {
         devDependencies: {
           typescript: "^5.5.0",
           vite: "^5.4.0",
+          vitest: "^1.6.0",
         },
       },
       null,
@@ -529,8 +704,10 @@ export function screenVanilla(gameId) {
 import type { GameResults } from '@smoregg/sdk';
 
 interface GameEvents {
+  // Screen → Controller (view state)
   'score-update': { score: number };
   'personal-message': { text: string };
+  // Controller → Screen (input)
   'tap': { timestamp: number };
 }
 
@@ -584,6 +761,8 @@ screen.onAllReady(() => {
 
 // Use screen.on(event, handler) / screen.off(event, handler) for dynamic event listeners.
 // destroy() automatically removes all listeners, so explicit off() cleanup is not needed.
+let tapCount = 0;
+
 screen.on('tap', (playerIndex, data) => {
   const line = document.createElement('div');
   line.textContent = \`Player \${playerIndex} tapped\`;
@@ -592,6 +771,9 @@ screen.on('tap', (playerIndex, data) => {
   while (logEl.children.length > 10) {
     logEl.removeChild(logEl.firstChild!);
   }
+  // Broadcast updated score back to controllers (Screen is source of truth)
+  tapCount++;
+  screen.broadcast('score-update', { score: tapCount });
 });
 
 function updateStatus() {
@@ -600,8 +782,7 @@ function updateStatus() {
 }
 
 // Example functions (can be called from console for testing):
-// screen.broadcast('score-update', { score: 100 });
-// screen.sendToController(0, 'message', { text: 'Hello!' });
+// screen.sendToController(0, 'personal-message', { text: 'Hello!' });
 // const results: GameResults = {
 //   scores: { 0: 50, 1: 75 },
 //   // winner: 0,
@@ -609,6 +790,7 @@ function updateStatus() {
 // };
 // screen.gameOver(results);
 `,
+    "src/__tests__/game.test.ts": screenTestFileVanilla(),
   };
 }
 
@@ -660,6 +842,7 @@ export function controllerReact(gameId) {
         scripts: {
           dev: "vite",
           build: "tsc && vite build",
+          test: "vitest run",
         },
         dependencies: {
           react: "^18.3.1",
@@ -672,6 +855,7 @@ export function controllerReact(gameId) {
           "@vitejs/plugin-react": "^4.3.0",
           typescript: "^5.5.0",
           vite: "^5.4.0",
+          vitest: "^1.6.0",
         },
       },
       null,
@@ -715,18 +899,35 @@ import { App } from './App';
 createRoot(document.getElementById('root')!).render(<App />);
 `,
     "src/App.tsx": `import { createController } from '@smoregg/sdk';
-import type { Controller } from '@smoregg/sdk';
+import type { Controller, ControllerInfo } from '@smoregg/sdk';
 import { useEffect, useRef, useState } from 'react';
 
 interface GameEvents {
+  // Screen → Controller (view state)
   'score-update': { score: number };
   'personal-message': { text: string };
+  // Controller → Screen (input)
   'tap': { timestamp: number };
 }
 
+/**
+ * ARCHITECTURE: Stateless Controller Pattern
+ *
+ * The controller is a stateless display + input device:
+ * - Render ONLY what the Screen sends (via controller.on())
+ * - Send ONLY user input to Screen (via controller.send())
+ * - Do NOT store or compute game state here
+ *
+ * Data flow:
+ *   Controller → Screen: controller.send('tap', { timestamp })  (input only)
+ *   Screen → Controller: 'score-update' { score }               (view state)
+ *   Controller renders: score from Screen (source of truth)
+ */
+
 export function App() {
   const controllerRef = useRef<Controller | null>(null);
   const [myIndex, setMyIndex] = useState(-1);
+  const [me, setMe] = useState<ControllerInfo | null>(null);
   const [count, setCount] = useState(0);
   const [isReady, setIsReady] = useState(false);
 
@@ -745,6 +946,7 @@ export function App() {
     controller.onAllReady(() => {
       if (!mounted) return;
       setMyIndex(controller.myPlayerIndex);
+      setMe(controller.me);
       setIsReady(true);
     });
 
@@ -768,7 +970,6 @@ export function App() {
 
   const handleTap = () => {
     controllerRef.current?.send('tap', { timestamp: Date.now() });
-    setCount((c) => c + 1);
   };
 
   return (
@@ -779,7 +980,7 @@ export function App() {
       touchAction: 'manipulation', userSelect: 'none',
     }}>
       {isReady && (
-        <div style={{ fontSize: '16px', opacity: 0.6 }}>Player {myIndex}</div>
+        <div style={{ fontSize: '16px', opacity: 0.6 }}>{me?.nickname ?? \`Player \${myIndex}\`}</div>
       )}
       <div style={{ fontSize: '48px', fontWeight: 'bold' }}>{count}</div>
       <button
@@ -797,6 +998,7 @@ export function App() {
   );
 }
 `,
+    "src/__tests__/game.test.ts": controllerTestFile(),
   };
 }
 
@@ -811,6 +1013,7 @@ export function controllerVanilla(gameId) {
         scripts: {
           dev: "vite",
           build: "tsc && vite build",
+          test: "vitest run",
         },
         dependencies: {
           "@smoregg/sdk": SDK_VERSION, // TODO: auto-detect or update on release
@@ -818,6 +1021,7 @@ export function controllerVanilla(gameId) {
         devDependencies: {
           typescript: "^5.5.0",
           vite: "^5.4.0",
+          vitest: "^1.6.0",
         },
       },
       null,
@@ -876,12 +1080,26 @@ export default defineConfig({
     "src/main.ts": `import { createController } from '@smoregg/sdk';
 
 interface GameEvents {
+  // Screen → Controller (view state)
   'score-update': { score: number };
   'personal-message': { text: string };
+  // Controller → Screen (input)
   'tap': { timestamp: number };
 }
 
-let count = 0;
+/**
+ * ARCHITECTURE: Stateless Controller Pattern
+ *
+ * The controller is a stateless display + input device:
+ * - Render ONLY what the Screen sends (via controller.on())
+ * - Send ONLY user input to Screen (via controller.send())
+ * - Do NOT store or compute game state here
+ *
+ * Data flow:
+ *   Controller → Screen: controller.send('tap', { timestamp })  (input only)
+ *   Screen → Controller: 'score-update' { score }               (view state)
+ *   Controller renders: score from Screen (source of truth)
+ */
 
 const playerInfoEl = document.getElementById('player-info')!;
 const countEl = document.getElementById('count')!;
@@ -897,12 +1115,11 @@ const controller = createController<GameEvents>({ debug: true });
 // To control autoReady: createScreen({ autoReady: false }) or createController({ autoReady: false })
 
 controller.onAllReady(() => {
-  playerInfoEl.textContent = \`Player \${controller.myPlayerIndex}\`;
+  playerInfoEl.textContent = controller.me?.nickname ?? \`Player \${controller.myPlayerIndex}\`;
 });
 
 controller.on('score-update', (data) => {
-  count = data.score;
-  countEl.textContent = String(count);
+  countEl.textContent = String(data.score);
 });
 
 controller.on('personal-message', (data) => {
@@ -911,10 +1128,9 @@ controller.on('personal-message', (data) => {
 
 tapBtn.addEventListener('pointerdown', () => {
   controller.send('tap', { timestamp: Date.now() });
-  count++;
-  countEl.textContent = String(count);
 });
 `,
+    "src/__tests__/game.test.ts": controllerTestFileVanilla(),
   };
 }