create-esengine-server 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ESEngine Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -0,0 +1,511 @@
+#!/usr/bin/env node
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/index.ts
+import { Command } from "commander";
+import prompts from "prompts";
+import chalk from "chalk";
+import * as fs from "fs";
+import * as path from "path";
+import { execSync } from "child_process";
+import { fileURLToPath } from "url";
+var __dirname = path.dirname(fileURLToPath(import.meta.url));
+var VERSION = "1.0.0";
+function printLogo() {
+  console.log();
+  console.log(chalk.cyan("  \u256D\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256E"));
+  console.log(chalk.cyan("  \u2502                                      \u2502"));
+  console.log(chalk.cyan("  \u2502   ") + chalk.bold.white("Create ESEngine Server") + chalk.cyan("         \u2502"));
+  console.log(chalk.cyan("  \u2502                                      \u2502"));
+  console.log(chalk.cyan("  \u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256F"));
+  console.log();
+}
+__name(printLogo, "printLogo");
+function detectPackageManager() {
+  const userAgent = process.env.npm_config_user_agent || "";
+  if (userAgent.includes("pnpm")) return "pnpm";
+  if (userAgent.includes("yarn")) return "yarn";
+  return "npm";
+}
+__name(detectPackageManager, "detectPackageManager");
+function getInstallCommand(pm) {
+  return pm === "yarn" ? "yarn" : `${pm} install`;
+}
+__name(getInstallCommand, "getInstallCommand");
+function writeFile(projectPath, relativePath, content) {
+  const fullPath = path.join(projectPath, relativePath);
+  fs.mkdirSync(path.dirname(fullPath), {
+    recursive: true
+  });
+  fs.writeFileSync(fullPath, content);
+}
+__name(writeFile, "writeFile");
+function generateProject(projectPath, projectName) {
+  const packageJson = {
+    name: projectName,
+    version: "1.0.0",
+    type: "module",
+    private: true,
+    scripts: {
+      dev: "tsx watch src/server/main.ts",
+      start: "tsx src/server/main.ts",
+      build: "tsc",
+      "build:start": "tsc && node dist/server/main.js"
+    },
+    dependencies: {
+      "@esengine/server": "latest",
+      "@esengine/rpc": "latest"
+    },
+    devDependencies: {
+      "@types/node": "^20.0.0",
+      tsx: "^4.0.0",
+      typescript: "^5.0.0"
+    }
+  };
+  writeFile(projectPath, "package.json", JSON.stringify(packageJson, null, 2));
+  const tsconfig = {
+    compilerOptions: {
+      target: "ES2022",
+      module: "NodeNext",
+      moduleResolution: "NodeNext",
+      lib: [
+        "ES2022"
+      ],
+      outDir: "./dist",
+      rootDir: "./src",
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      forceConsistentCasingInFileNames: true,
+      declaration: true,
+      sourceMap: true,
+      experimentalDecorators: true,
+      emitDecoratorMetadata: true
+    },
+    include: [
+      "src/**/*"
+    ],
+    exclude: [
+      "node_modules",
+      "dist"
+    ]
+  };
+  writeFile(projectPath, "tsconfig.json", JSON.stringify(tsconfig, null, 2));
+  const protocolTs = `/**
+ * \u6E38\u620F\u534F\u8BAE\u5B9A\u4E49
+ * Game Protocol Definition
+ *
+ * \u8FD9\u4E2A\u6587\u4EF6\u5B9A\u4E49\u4E86\u5BA2\u6237\u7AEF\u548C\u670D\u52A1\u7AEF\u5171\u4EAB\u7684\u534F\u8BAE\u7C7B\u578B
+ * This file defines protocol types shared between client and server
+ */
+
+// ============================================================================
+// \u623F\u95F4 API | Room API
+// ============================================================================
+
+/** \u52A0\u5165\u623F\u95F4\u8BF7\u6C42 | Join room request */
+export interface JoinRoomReq {
+    roomType: string
+    playerName: string
+    options?: Record<string, unknown>
+}
+
+/** \u52A0\u5165\u623F\u95F4\u54CD\u5E94 | Join room response */
+export interface JoinRoomRes {
+    roomId: string
+    playerId: string
+}
+
+// ============================================================================
+// \u6E38\u620F\u6D88\u606F | Game Messages
+// ============================================================================
+
+/** \u79FB\u52A8\u6D88\u606F | Move message */
+export interface MsgMove {
+    x: number
+    y: number
+}
+
+/** \u804A\u5929\u6D88\u606F | Chat message */
+export interface MsgChat {
+    text: string
+}
+
+// ============================================================================
+// \u670D\u52A1\u7AEF\u5E7F\u64AD | Server Broadcasts
+// ============================================================================
+
+/** \u73A9\u5BB6\u52A0\u5165\u5E7F\u64AD | Player joined broadcast */
+export interface BroadcastJoined {
+    playerId: string
+    playerName: string
+}
+
+/** \u73A9\u5BB6\u79BB\u5F00\u5E7F\u64AD | Player left broadcast */
+export interface BroadcastLeft {
+    playerId: string
+}
+
+/** \u72B6\u6001\u540C\u6B65\u5E7F\u64AD | State sync broadcast */
+export interface BroadcastSync {
+    players: PlayerState[]
+}
+
+// ============================================================================
+// \u5171\u4EAB\u7C7B\u578B | Shared Types
+// ============================================================================
+
+/** \u73A9\u5BB6\u72B6\u6001 | Player state */
+export interface PlayerState {
+    id: string
+    name: string
+    x: number
+    y: number
+}
+`;
+  writeFile(projectPath, "src/shared/protocol.ts", protocolTs);
+  const sharedIndexTs = `export * from './protocol.js'
+`;
+  writeFile(projectPath, "src/shared/index.ts", sharedIndexTs);
+  const serverMainTs = `import { createServer } from '@esengine/server'
+import { GameRoom } from './rooms/GameRoom.js'
+
+const PORT = Number(process.env.PORT) || 3000
+
+async function main() {
+    const server = await createServer({
+        port: PORT,
+        onConnect(conn) {
+            console.log('[Server] Client connected:', conn.id)
+        },
+        onDisconnect(conn) {
+            console.log('[Server] Client disconnected:', conn.id)
+        },
+    })
+
+    // \u6CE8\u518C\u623F\u95F4\u7C7B\u578B
+    server.define('game', GameRoom)
+
+    await server.start()
+
+    console.log('========================================')
+    console.log('  ${projectName}')
+    console.log('========================================')
+    console.log(\`  WebSocket: ws://localhost:\${PORT}\`)
+    console.log('  Room type: "game"')
+    console.log('  Press Ctrl+C to stop')
+    console.log('========================================')
+}
+
+process.on('SIGINT', () => {
+    console.log('\\nShutting down...')
+    process.exit(0)
+})
+
+main().catch(console.error)
+`;
+  writeFile(projectPath, "src/server/main.ts", serverMainTs);
+  const gameRoomTs = `import { Room, Player, onMessage } from '@esengine/server'
+import type {
+    MsgMove,
+    MsgChat,
+    PlayerState,
+    BroadcastSync,
+    BroadcastJoined,
+    BroadcastLeft,
+} from '../../shared/index.js'
+
+/** \u73A9\u5BB6\u6570\u636E | Player data */
+interface PlayerData {
+    name: string
+    x: number
+    y: number
+}
+
+/**
+ * \u6E38\u620F\u623F\u95F4
+ * Game Room
+ */
+export class GameRoom extends Room<{ players: PlayerState[] }, PlayerData> {
+    // \u914D\u7F6E
+    maxPlayers = 8
+    tickRate = 20
+
+    // \u72B6\u6001
+    state = {
+        players: [] as PlayerState[],
+    }
+
+    // ========================================================================
+    // \u751F\u547D\u5468\u671F | Lifecycle
+    // ========================================================================
+
+    onCreate() {
+        console.log(\`[GameRoom] Room \${this.id} created\`)
+    }
+
+    onJoin(player: Player<PlayerData>) {
+        // \u521D\u59CB\u5316\u73A9\u5BB6\u6570\u636E
+        player.data.name = 'Player_' + player.id.slice(-4)
+        player.data.x = Math.random() * 800
+        player.data.y = Math.random() * 600
+
+        // \u6DFB\u52A0\u5230\u72B6\u6001
+        this.state.players.push({
+            id: player.id,
+            name: player.data.name,
+            x: player.data.x,
+            y: player.data.y,
+        })
+
+        // \u5E7F\u64AD\u73A9\u5BB6\u52A0\u5165
+        this.broadcast<BroadcastJoined>('Joined', {
+            playerId: player.id,
+            playerName: player.data.name,
+        })
+
+        console.log(\`[GameRoom] \${player.data.name} joined room \${this.id}\`)
+    }
+
+    onLeave(player: Player<PlayerData>) {
+        // \u4ECE\u72B6\u6001\u79FB\u9664
+        this.state.players = this.state.players.filter(p => p.id !== player.id)
+
+        // \u5E7F\u64AD\u73A9\u5BB6\u79BB\u5F00
+        this.broadcast<BroadcastLeft>('Left', {
+            playerId: player.id,
+        })
+
+        console.log(\`[GameRoom] \${player.data.name} left room \${this.id}\`)
+    }
+
+    onTick(_dt: number) {
+        // \u5E7F\u64AD\u72B6\u6001\u540C\u6B65
+        this.broadcast<BroadcastSync>('Sync', {
+            players: this.state.players,
+        })
+    }
+
+    onDispose() {
+        console.log(\`[GameRoom] Room \${this.id} disposed\`)
+    }
+
+    // ========================================================================
+    // \u6D88\u606F\u5904\u7406 | Message Handlers
+    // ========================================================================
+
+    @onMessage('Move')
+    handleMove(data: MsgMove, player: Player<PlayerData>) {
+        player.data.x = data.x
+        player.data.y = data.y
+
+        // \u66F4\u65B0\u72B6\u6001
+        const p = this.state.players.find(p => p.id === player.id)
+        if (p) {
+            p.x = data.x
+            p.y = data.y
+        }
+    }
+
+    @onMessage('Chat')
+    handleChat(data: MsgChat, player: Player<PlayerData>) {
+        // \u5E7F\u64AD\u804A\u5929\u6D88\u606F
+        this.broadcast('Chat', {
+            from: player.data.name,
+            text: data.text,
+        })
+    }
+}
+`;
+  writeFile(projectPath, "src/server/rooms/GameRoom.ts", gameRoomTs);
+  const clientIndexTs = `/**
+ * \u5BA2\u6237\u7AEF\u793A\u4F8B\u4EE3\u7801
+ * Client Example Code
+ *
+ * \u8FD9\u662F\u4E00\u4E2A\u793A\u4F8B\uFF0C\u5C55\u793A\u5982\u4F55\u4ECE\u5BA2\u6237\u7AEF\u8FDE\u63A5\u670D\u52A1\u5668
+ * This is an example showing how to connect to the server from client
+ */
+
+import { connect } from '@esengine/rpc/client'
+import type {
+    JoinRoomReq,
+    JoinRoomRes,
+    MsgMove,
+    BroadcastSync,
+    BroadcastJoined,
+} from '../shared/index.js'
+
+async function main() {
+    // \u8FDE\u63A5\u670D\u52A1\u5668
+    const client = await connect('ws://localhost:3000')
+
+    // \u52A0\u5165\u623F\u95F4
+    const result = await client.call<JoinRoomReq, JoinRoomRes>('JoinRoom', {
+        roomType: 'game',
+        playerName: 'Alice',
+    })
+    console.log('Joined room:', result.roomId)
+
+    // \u76D1\u542C\u5E7F\u64AD
+    client.onMessage<BroadcastJoined>('Joined', (data) => {
+        console.log('Player joined:', data.playerName)
+    })
+
+    client.onMessage<BroadcastSync>('Sync', (data) => {
+        console.log('State update:', data.players.length, 'players')
+    })
+
+    // \u53D1\u9001\u79FB\u52A8\u6D88\u606F
+    client.send<MsgMove>('RoomMessage', {
+        type: 'Move',
+        payload: { x: 100, y: 200 },
+    })
+}
+
+main().catch(console.error)
+`;
+  writeFile(projectPath, "src/client/index.ts", clientIndexTs);
+  const gitignore = `node_modules/
+dist/
+*.log
+.DS_Store
+`;
+  writeFile(projectPath, ".gitignore", gitignore);
+  const readme = `# ${projectName}
+
+ESEngine \u6E38\u620F\u670D\u52A1\u5668\u9879\u76EE\u3002
+
+## \u9879\u76EE\u7ED3\u6784
+
+\`\`\`
+src/
+\u251C\u2500\u2500 shared/                 # \u5171\u4EAB\u534F\u8BAE\uFF08\u5BA2\u6237\u7AEF\u670D\u52A1\u7AEF\u90FD\u7528\uFF09
+\u2502   \u251C\u2500\u2500 protocol.ts         # \u7C7B\u578B\u5B9A\u4E49
+\u2502   \u2514\u2500\u2500 index.ts
+\u251C\u2500\u2500 server/                 # \u670D\u52A1\u7AEF
+\u2502   \u251C\u2500\u2500 main.ts             # \u5165\u53E3
+\u2502   \u2514\u2500\u2500 rooms/
+\u2502       \u2514\u2500\u2500 GameRoom.ts     # \u6E38\u620F\u623F\u95F4
+\u2514\u2500\u2500 client/                 # \u5BA2\u6237\u7AEF\u793A\u4F8B
+    \u2514\u2500\u2500 index.ts
+\`\`\`
+
+## \u5FEB\u901F\u5F00\u59CB
+
+\`\`\`bash
+# \u542F\u52A8\u670D\u52A1\u5668
+npm run dev
+
+# \u670D\u52A1\u5668\u5C06\u5728 ws://localhost:3000 \u542F\u52A8
+\`\`\`
+
+## \u5BA2\u6237\u7AEF\u8FDE\u63A5
+
+\`\`\`typescript
+import { connect } from '@esengine/rpc/client'
+
+const client = await connect('ws://localhost:3000')
+
+// \u52A0\u5165\u623F\u95F4
+const { roomId } = await client.call('JoinRoom', {
+    roomType: 'game',
+    playerName: 'Alice',
+})
+
+// \u76D1\u542C\u540C\u6B65
+client.onMessage('Sync', (state) => {
+    console.log(state.players)
+})
+
+// \u53D1\u9001\u6D88\u606F
+client.send('RoomMessage', { type: 'Move', payload: { x: 100, y: 200 } })
+\`\`\`
+`;
+  writeFile(projectPath, "README.md", readme);
+}
+__name(generateProject, "generateProject");
+async function main() {
+  printLogo();
+  const program = new Command();
+  program.name("create-esengine-server").description("Create a new ESEngine game server project").version(VERSION).argument("[project-name]", "Name of the project").action(async (projectName) => {
+    if (!projectName) {
+      const response = await prompts({
+        type: "text",
+        name: "name",
+        message: "Project name:",
+        initial: "my-game-server"
+      }, {
+        onCancel: /* @__PURE__ */ __name(() => {
+          console.log(chalk.yellow("\n  Cancelled."));
+          process.exit(0);
+        }, "onCancel")
+      });
+      projectName = response.name;
+    }
+    if (!projectName) {
+      console.log(chalk.red("  Project name is required."));
+      process.exit(1);
+    }
+    const projectPath = path.resolve(process.cwd(), projectName);
+    if (fs.existsSync(projectPath)) {
+      const files = fs.readdirSync(projectPath);
+      if (files.length > 0) {
+        const response = await prompts({
+          type: "confirm",
+          name: "overwrite",
+          message: `Directory "${projectName}" is not empty. Continue?`,
+          initial: false
+        });
+        if (!response.overwrite) {
+          console.log(chalk.yellow("\n  Cancelled."));
+          process.exit(0);
+        }
+      }
+    } else {
+      fs.mkdirSync(projectPath, {
+        recursive: true
+      });
+    }
+    console.log();
+    console.log(chalk.bold(`  Creating project in ${chalk.cyan(projectPath)}...`));
+    console.log();
+    generateProject(projectPath, projectName);
+    console.log(chalk.green("  \u2713 Created project files"));
+    const pm = detectPackageManager();
+    const installCmd = getInstallCommand(pm);
+    console.log(chalk.gray(`  Running ${installCmd}...`));
+    console.log();
+    try {
+      execSync(installCmd, {
+        cwd: projectPath,
+        stdio: "inherit"
+      });
+      console.log();
+      console.log(chalk.green("  \u2713 Dependencies installed"));
+    } catch {
+      console.log(chalk.yellow(`
+  \u26A0 Failed to install. Run "${installCmd}" manually.`));
+    }
+    console.log();
+    console.log(chalk.bold("  Done! Next steps:"));
+    console.log();
+    console.log(chalk.cyan(`    cd ${projectName}`));
+    console.log(chalk.cyan(`    ${pm} run dev`));
+    console.log();
+    console.log(chalk.gray("  Project structure:"));
+    console.log(chalk.gray("    src/"));
+    console.log(chalk.gray("    \u251C\u2500\u2500 shared/           # Shared protocol types"));
+    console.log(chalk.gray("    \u2502   \u2514\u2500\u2500 protocol.ts"));
+    console.log(chalk.gray("    \u251C\u2500\u2500 server/           # Server code"));
+    console.log(chalk.gray("    \u2502   \u251C\u2500\u2500 main.ts"));
+    console.log(chalk.gray("    \u2502   \u2514\u2500\u2500 rooms/"));
+    console.log(chalk.gray("    \u2502       \u2514\u2500\u2500 GameRoom.ts"));
+    console.log(chalk.gray("    \u2514\u2500\u2500 client/           # Client example"));
+    console.log(chalk.gray("        \u2514\u2500\u2500 index.ts"));
+    console.log();
+  });
+  program.parse();
+}
+__name(main, "main");
+main().catch(console.error);

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "create-esengine-server",
+  "version": "1.1.0",
+  "description": "Create ESEngine game server projects",
+  "type": "module",
+  "bin": {
+    "create-esengine-server": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/prompts": "^2.4.9",
+    "tsup": "^8.0.0",
+    "typescript": "^5.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "esengine",
+    "create",
+    "game-server",
+    "scaffold",
+    "cli"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}