应用场景(概览)
按你的玩法 直接跳对应文档;每条下面链到站内说明(客户端 / 服务端 / 运维各取所需)。
实时多人对战与帧同步
适合 MOBA、格斗、横版过关等对 操作一致性 要求高的玩法。
- 能力:
game_room+ 帧同步与游戏房,固定帧率收集input、Schema 状态同步,支持匹配下发的座位与 断线重连。 - 客户端:任选 Unity、Cocos Creator、Godot 等,按官方 SDK 接入后再绑定本项目 JWT。
- 文档侧重:服务端消息名与房间契约;客户端预测 / 回滚在引擎侧实现。
格斗游戏帧同步(专项)
1v1 / 小人数格斗:独立 modeId(如 fighting_1v1)、playersPerMatch: 2,在 input.inputs 中约定方向与按键位掩码;框架负责帧 Tick 与房间契约,判定与手感在您侧实现。步骤与示例见:格斗游戏帧同步。
匹配大厅与房间码组队
适合「一键匹配路人」或「好友输入房间码组队开局」。
- 能力:匹配与开房 中的
matchmaker_room:主动排队match:find、取消match:cancel,以及 Partyparty:create/party:join/party:start;组局成功后进入game_room。 - 依赖:Redis(本地跑通请先起 Redis)。
- 客户端:登录拿 JWT → 进
matchmaker_room→ 收match:found→joinById进game_room(步骤见 匹配与开房)。
组队下副本 + 队伍聊天(专项)
被动开房(房间码 Party)与 chat_team_room 组合:等人、打字沟通、房主开局进 game_room。步骤、消息与 TypeScript 示例代码 见:组队下副本:被动开房(Party)+ 队伍聊天。
小游戏邀请好友对战(专项)
适合微信/抖音小游戏的“分享拉人”链路:房主创建 Party,好友通过分享参数加入,房主开局后统一收到 match:found 进入 game_room。入口与校验建议见:小游戏邀请好友对战(Party 邀约)。
排位赛(专项)
路人 match:find 排队,按 modeId / playersPerMatch(即开局 game_room 人数,如 1v1=2、2v2=4、4v4=8,在 2~100 内)/ region 成局;段位与 MMR 等在业务层扩展,匹配与成局用框架自带 matchmaker_room。说明与延伸阅读见:排位赛。
多 V 多自动匹配(多模式 × 动态人数)
同一套 matchmaker_room:改 modeId / playersPerMatch / region 即可支持 2 人、4 人、10 人、行会场等。浏览器演示 + 参数速查 见:多 V 多自动匹配。
世界 / 工会 / 附近 / 队伍聊天
适合 MMO-like 社交、公会频道、小队语音文字配套、地图附近可见聊天。
- 能力:四类聊天房间(
chat_world_room等),世界频道支持 Redis Pub/Sub 跨进程同步(见 多模式聊天、消息协议)。 - 参数:进房 options 中带
guildId、teamId、坐标与nearbyRadius等;消息chat、updatePosition(附近)。 - 鉴权:与业务房间一致,需 JWT 与房间鉴权。
微信 / 抖音小游戏登录与账号体系
适合小程序渠道获客、与站内用户表打通。
- 能力:
GET /api/minigame/weixin/login、douyin/login换平台票据并 findOrCreate 本地用户,返回token+user(不含密码);JWTuserId为库主键。 - 文档:微信小游戏登录、抖音小游戏登录、API 概览。
- 衔接:小游戏拿到的 access token 与账号密码登录一样,用于 Colyseus 进房
token字段。
HTTP API + 实时房间混合架构
适合「大厅与支付走 HTTP,战斗走 WebSocket」的常见手游架构。
- 能力:Express + routing-controllers(Swagger)、JWT;Colyseus 专注房间与状态。
- 文档:API 概览、JWT 与房间鉴权、项目结构。
- 注意:HTTP
Bearer与房间@RequireAuth的 Redis 校验策略不完全相同,关键路径以文档为准。
压测、演示与二次开发基线
- 压测:
loadtest_room(无 JWT,仅测试)与loadtest/脚本;生产关闭与环境变量说明见 人数压力测。 - 演示:
my_room可作为最小房间模板;Playground / Monitor 便于开发期调试(生产勿暴露 Playground)。
延伸阅读
| 方向 | 入口 |
|---|---|
| 房间与协议全集 | 房间机制概览、消息协议 |
| 部署与多实例 / 压测 | 部署说明、人数压力测、匹配文档中的 Redis 说明 |
| 从零搭建环境 | 安装指南、配置说明 |