Coldmooon / GameServer

GameServer

一个使用FastAPI构建的游戏后台服务，提供RESTful API和WebSocket接口。

简介

GameServer是一个使用FastAPI构建的游戏后台服务，旨在为游戏提供高性能的RESTful API和WebSocket接口。

遵循 Star Protocol 提供 Agent 通信。

安装

确保你已安装Python 3.13.2或更高版本和uv。

# 克隆仓库
git clone https://github.com/Lounger-Habitat/GameServer
cd GameServer

# 使用uv安装依赖
uv sync

运行服务

# 启动服务器
uv run fastapi dev gameserver/main.py # 部署替换为 fastapi run 

服务将在 http://localhost:8000 上运行。

API文档

启动服务后，可以访问以下URL查看API文档：

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

WebSocket

WebSocket接口可通过 ws://localhost:8000/ws 访问。

测试

# 运行测试
uv run -m pytest

项目结构

gameserver/
├── __init__.py
├── main.py           # 应用入口
├── api/              # RESTful API路由
├── ws/               # WebSocket处理
├── models/           # 数据模型
├── services/         # 业务逻辑
└── utils/            # 工具函数
tests/                # 测试目录