skyext

KO | EN

gitlite — search

#android #typescript #ai #llm #python #docker #flutter #javascript #websocket #java #postgresql #go

★ 46 Open GitHub ↗

🎮 [WIP] 基于 skynet 实现的一个游戏服务器 🚀 欢迎 Star & Fork！

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 游戏服务器 skyext

🎮 [WIP] [skyext](https://github.com/hanxi/skyext) 是一个基于 [skynet](https://github.com/cloudwu/skynet) 实现的分布式游戏服务器框架

🚀 欢迎 Star & Fork！

目前还处于早期开发中，仅用于学习参考！

## ✨ 特性

- **分布式架构**: 基于 skynet 实现的高性能分布式游戏服务器
- **微服务设计**: 支持 account 节点和 role 节点分离部署
- **ORM 支持**: 内置 ORM 框架，支持 MongoDB 数据持久化
- **协议管理**: 使用 sproto 协议，支持协议版本校验
- **服务发现**: 基于 etcd 的服务注册与发现
- **JWT 认证**: 支持 JWT token 登录验证
- **日志系统**: 完善的日志记录和管理系统
- [ ] **热更新**: 支持代码热更新和配置热加载
- [ ] **监控系统**: 完善监控告警系统
- [ ] **管理后台**: 完善管理后台，包括火焰图分析

## 🏗️ 架构设计

### 节点类型

- **Account 节点**: 负责用户账号管理、登录验证、角色创建等
- **Role 节点**: 负责角色数据管理、游戏逻辑处理
- **Robot 节点**: 机器人客户端，用于压力测试

### 核心模块

- **ORM 系统**: `lualib/orm/` - 对象关系映射，支持数据版本管理
- **服务发现**: `lualib/cluster_discovery.lua` - 基于 etcd 的集群发现
- **数据库管理**: `lualib/dbmgr.lua` - MongoDB 连接池管理
- **协议处理**: `lualib/sproto_api.lua` - sproto 协议编解码
- **HTTP 服务**: `lualib/http_server/` - HTTP 服务器实现
- **分布式锁**: `lualib/distributed_lock.lua` - 基于 etcd 的分布式锁

## 📋 依赖环境

- **skynet**: 游戏服务器框架
- **etcd**: 服务发现和配置管理
- **MongoDB**: 数据持久化存储
- **libsodium**: 加密库
- **lua-cjson**: JSON 处理
- **sproto**: 协议序列化

## 🚀 快速开始

### 1. 初始化项目

```bash
# 克隆项目
git clone https://github.com/hanxi/skyext.git
cd skyext

# 初始化子模块
make init

# 编译项目
make build
```

### 2. 启动基础服务

启动 etcd 集群：

```bash
cd tools/etcd
docker compose up -d
```

启动 MongoDB：

```bash
cd tools/mongodb
docker compose up -d
```

### 3. 生成协议和模式文件

```bash
# 生成协议文件
make proto

# 生成 ORM 模式文件
make schema

# 生成代码
make autocode
```

### 4. 启动游戏服务器

```bash
# 启动 account 节点（支持多实例）
./bin/skynet etc/account1.conf.lua
./bin/skynet etc/account2.conf.lua

# 启动 role 节点（支持多实例）
./bin/skynet etc/role1.conf.lua
./bin/skynet etc/role2.conf.lua
```

### 5. 启动机器人测试

```bash
# 启动机器人客户端进行测试
./bin/skynet etc/robot.conf.lua
```

## 📁 目录结构

```
skyext/
├── app/                   # 应用程序入口
│   ├── account/           # 账号服务
│   ├── role/              # 角色服务
│   └── robot/             # 机器人客户端
├── etc/                   # 配置文件
├── lualib/                # Lua 库文件
│   ├── orm/               # ORM 框架
│   ├── http_server/       # HTTP 服务器
│   └── util/              # 工具库
├── proto/                 # 协议定义文件
├── schema/                # 数据模式定义
├── service/               # 服务模块
├── tools/                 # 工具脚本
└── test/                  # 测试用例
```

## ⚙️ 配置说明

### 配置文件结构

项目采用分层配置设计，配置文件分为两个层级：

1. **节点配置文件**：位于 `etc/` 目录下，定义节点启动参数
   - `etc/account*.conf.lua`: Account 节点配置文件
   - `etc/role*.conf.lua`: Role 节点配置文件
   - `etc/core.conf.lua`: 核心配置文件，包含 skynet 框架基础配置

2. **应用配置文件**：位于 `etc/app/` 目录下，定义具体业务配置
   - `etc/app/common.app.lua`: 通用业务配置（日志、数据库、etcd 等）
   - `etc/app/account*.app.lua`: Account 节点业务配置
   - `etc/app/role*.app.lua`: Role 节点业务配置
   - `etc/app/robot.app.lua`: 机器人客户端业务配置

### 节点配置文件

节点配置文件是 skynet 启动时加载的配置，主要定义：

- 启动脚本路径
- Lua 搜索路径
- 线程数等基础参数
- 应用配置文件路径

示例 (`etc/account1.conf.lua`)：
```lua
app_config_path = "etc/app/account1.app.lua"
start = "account" -- 主脚本 account/main.lua
include "core.conf.lua" -- 包含核心配置
```

### 应用配置文件

应用配置文件定义具体的业务参数，支持以下数据类型：
- string: 字符串类型
- number: 数值类型
- boolean: 布尔类型
- table: 表类型（复杂配置结构）

示例 (`etc/app/common.app.lua`)：
```lua
-- 日志配置
log_level = 4 -- 日志等级 DEBUG = 4, INFO = 3, WARN = 2, ERROR = 1, FATAL = 0

-- 数据库配置
mongo_config = {
    center = {
        connections = 4, -- 连接数
        cfg = {
            host = "127.0.0.1",
            port = 27017,
        },
    },
}

-- 其他配置
max_role_count = 5 -- 最大角色数量
```

### config 配置模块

配置模块 (`lualib/config.lua`) 提供统一的配置读取接口：
- `config.get(key)`: 获取字符串类型配置
- `config.get_boolean(key)`: 获取布尔类型配置
- `config.get_number(key)`: 获取数值类型配置
- `config.get_table(key)`: 获取表类型配置

配置语法遵循 [skynet 官方文档 Config](https://github.com/cloudwu/skynet/wiki/Config) 规范。应用配置文件支持 table 类型配置，支持嵌套结构。

## 🔧 开发工具

```bash
# 清理编译文件
make clean

# 完全清理
make cleanall

# 打包发布
make dist

# 查看所有可用命令
make help
```

## 🎮 游戏功能

### 已实现功能

- **用户系统**: 账号注册、登录、JWT 认证
- **角色系统**: 角色创建、数据持久化、模块化设计
- **服务发现**: 动态服务注册与发现

### 扩展模块

项目采用模块化设计，可以轻松扩展新功能：

- 在 `schema/` 目录定义数据结构
- 在 `proto/roleagent/` 目录定义协议
- 使用 `make autocode` 自动生成模块代码

### 计划实现功能

- **策划配置**: 策划 excel 配置管理
- **背包系统**: 物品管理
- **邮件系统**: 邮件收发功能
- **社交系统**: 好友系统、群聊系统
- **游戏内商城**: 商品管理、交易功能
- **交易系统**: 物品交易拍卖功能
- **副本系统**: 副本创建、副本内玩法
- **排行榜系统**: 玩家排行榜
- **活动系统**: 活动管理、活动玩法

## 🔗 相关工程

- **Demo 客户端**: [phaser-game](https://github.com/hanxi/phaser-game) - 基于 Phaser 的游戏客户端
- **网关服务**: [goscon](https://github.com/hanxi/goscon) - WebSocket 转 TCP 网关
- **登录鉴权**: [gamepass](https://github.com/hanxi/gamepass) - 第三方登录鉴权服务

## 📚 文档

- [项目 Wiki](https://github.com/hanxi/skyext/wiki) - 详细开发文档
- [Skynet 官方文档](https://github.com/cloudwu/skynet/wiki) - Skynet 框架文档

## 💬 交流讨论

- **QQ 群**: `677839887`
- **GitHub Issues**: 提交 Bug 报告和功能建议

## 📄 许可证

本项目基于 MIT 许可证开源，详见 [LICENSE](LICENSE) 文件。

## 🤝 贡献

欢迎提交 Pull Request 和 Issue！

1. Fork 本项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request

skyext

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README