https://github.com/fishpioffical/tiaoom
🎮 轻量级游戏房间引擎
https://github.com/fishpioffical/tiaoom
Last synced: 6 days ago
JSON representation
🎮 轻量级游戏房间引擎
- Host: GitHub
- URL: https://github.com/fishpioffical/tiaoom
- Owner: FishPiOffical
- License: mit
- Created: 2023-07-24T07:47:17.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-05-11T06:24:56.000Z (about 2 months ago)
- Last Synced: 2026-05-11T08:30:10.957Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://tiaoom.com/
- Size: 2.21 MB
- Stars: 18
- Watchers: 1
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tiaoom - a Tiaoable project
轻量级游戏房间引擎
## ✨功能
- 玩家注册与登录；
- 多人在线房间管理；
- 房间内玩家实时互动；
- 可扩展的游戏逻辑接口；
## 🚀 快速开始
- 安装包 `tiaoom`：
```bash
npm install tiaoom
```
后端从 `tiaoom` 引入 `Tiaoom`，并继承实现通信方法：
```typescript
import { Tiaoom } from 'tiaoom';
class YourGameServer extends Tiaoom {
// 实现通信方法
}
```
> 具体见 `game/backend/src/controller.ts`
前端则从 `tiaoom/client` 引入 `Tiaoom`，并继承实现通信方法：
```typescript
import { Tiaoom } from 'tiaoom/client';
class YourGameClient extends Tiaoom {
// 实现通信方法
}
```
> 具体见 `game/frontend/src/core/game.ts`
## 🎮 实现游戏示例
本仓库内置一个基于 Websocket 为通信协议的游戏服务，实现新的游戏只需编写两个文件：
- game/backend/src/games/yourgame.js - 游戏逻辑入口与配置信息；
- game/frontend/src/components/yourgame/YourGameRoom.vue - 游戏前端组件；
完成后重启服务即可在前端选择运行游戏。
~~iwpz:跳佬已经被我绑架了，需要VM50才可以继续更新~~
目前已内置：
- 五子棋
- 四子棋
- 黑白棋
- 谁是卧底
- 抢数字
- 斗兽棋
- UNO (by [@csfwff](https://github.com/csfwff))
- 斗地主 (by [@zhazhahehedian](https://github.com/zhazhahehedian))
- 翻转象棋 (by [@zhazhahehedian](https://github.com/zhazhahehedian))
- 象棋 (by [@iwpz](https://github.com/iwpz))
- 药丸博弈 (by [@iwpz](https://github.com/iwpz))
- 俄罗斯方块 (by [@Cooooing](https://github.com/cooooing))
## ⚙️ 调试/运行
1. cd 到 `game`, 执行 `npm install`;
2. 使用 Visual Studio Code 运行调试（直接按下`F5`即可），或执行 `npm run dev:backend` 启动后端开发服务器。
3. 执行 `npm run dev:frontend` 启动前端开发服务器，访问 `http://localhost:5173` 即可开始开发。
4. 或执行 `npm run dev` 同时启动后端和前端，访问 `http://localhost:5173` 也可开始开发。
> 更多开发细节见 [摸鱼派竞技大厅开发指南](https://tiaoom.com/game/)
## 📁 目录与文件
- .vscode - VSCode 调试配置
- lib - 核心类库
- events - 各个数据事件定义
- models - 数据模型实现
- message.ts - 消息基础模型
- player.ts - 玩家基础模型
- room.ts - 房间基础模型
- client - 前端类库入口
- index.ts - 后端类库入口
- game - 游戏示例
- backend - 后端实现
- src
- controller.ts - 后端控制器实现
- index.ts - 后端入口
- games - 游戏逻辑实现
- frontend - 前端实现
- public - 静态资源
- src
- assets - 资源文件
- components - 游戏组件文件
- core - 前端核心类库实现
- views - 视图文件
- App.vue - 根组件
- main.ts - 前端入口