快速入门
小游码匠（仓库名 xymj-colyseus-server）是在 Colyseus 之上实现的 约束型 服务端：TypeScript + Express，约定 JWT、匹配房、帧同步房、聊天房等开箱能力。下面按 最短路径 跑起来；原理与目录细节见侧栏其他页。
1. 克隆并装依赖
在 xymj-colyseus-server 仓库根目录：
（服务端代码）
bash
npm install环境要求见 安装指南。
2. 配环境并起服务
复制并编辑 .env.development（MySQL、Redis（匹配/聊天队列需要）、JWT_SECRET 等），然后：
（服务端代码）
bash
npm run dev默认 http://localhost:2567（端口看 PORT）。
3. 验证 HTTP 与文档
| 做什么 | 地址 |
|---|---|
| Swagger | http://localhost:2567/api-docs |
| 框架介绍页（静态） | http://localhost:2567/ |
用 Swagger 或现有账号接口拿到 token，后面进 Colyseus 房间要放在 options 里（约定见 JWT 与房间鉴权 第 3 节）。
4. 浏览器里跑通匹配（推荐）
打开 http://localhost:2567/MatchmakingDemo.html，填服务地址与 JWT，多开标签页可测 match:find → match:found → 进 game_room。参数含义与多人数玩法见 多 V 多自动匹配。
5. 接下来看什么
| 目标 | 文档 |
|---|---|
| 环境变量全集 | 配置说明 |
| 房间名、目录 | 项目结构 |
| 匹配 / Party 消息名 | 匹配与开房、消息协议 |
| Unity / Cocos / Godot 连本服务 | 游戏引擎接入 |
| 按玩法选型 | 应用场景概览 |