mirror of https://github.com/GSManagerXZ/GameServerManager.git synced 2025-10-03 21:31:53 +08:00

GameServerManager（简称GSManager）现代化游戏一键部署面板，专为简化游戏服务器的部署、管理和维护而设计；注重steam、MC游戏一键开服 http://gsm.xiaozhuhouses.asia

Find a file

yxsj245 5651b29c42 修改版本号		2025-10-03 16:03:53 +08:00
.claude	完善筛选	2025-07-15 15:57:23 +08:00
.github	修改版本号	2025-10-03 16:03:53 +08:00
.trae/rules	修复问题	2025-08-09 16:47:57 +08:00
client	修改版本号	2025-10-03 16:03:53 +08:00
docs	适配arm	2025-09-25 12:34:58 +08:00
scripts	增加arm开发	2025-09-25 11:57:35 +08:00
server	完善本次功能	2025-09-26 10:10:32 +08:00
.env	增加docker热重载	2025-07-13 23:35:08 +08:00
.gitignore	新增定时备份	2025-09-25 22:07:33 +08:00
ARM64-启动指南.md	增加arm开发	2025-09-25 11:57:35 +08:00
dev-arm64.sh	增加arm开发	2025-09-25 11:57:35 +08:00
docker-compose-arm64.yml	增加arm构建	2025-09-24 21:59:33 +08:00
docker-compose.yml	增加arm构建	2025-09-24 21:59:33 +08:00
Dockerfile	增加arm构建	2025-09-24 21:59:33 +08:00
install-gsm3.sh	添加Linux一键安装脚本	2025-08-18 02:47:35 +08:00
LICENSE	Create LICENSE	2025-08-11 13:12:47 +08:00
package-lock.json	优化容器镜像	2025-08-29 11:14:00 +08:00
package.json	优化容器镜像	2025-08-29 11:14:00 +08:00
README.md	增加arm开发	2025-09-25 11:57:35 +08:00
start-arm64.sh	增加arm开发	2025-09-25 11:57:35 +08:00
start.sh	增加arm构建	2025-09-24 21:59:33 +08:00
开发.md	新增定时备份	2025-09-25 22:07:33 +08:00
报错.txt	增加盘符切换	2025-07-17 22:11:53 +08:00

README.md

GameServerManager 3.0

新一代游戏服务器管理平台 - 让游戏服务器的部署、管理和维护变得简单高效

📖 文档站 • 🌐 官方网站 • 💬 QQ群

📋 项目简介

GameServerManager 3.0（简称GSM3）是一个基于现代化技术栈的游戏服务器管理平台，采用 React + TypeScript + Node.js 架构，专为简化游戏服务器的部署、管理和维护而设计。

🎉 GSM3.0 重大更新

✨ 核心特性

🚀 现代化架构 - 基于 React 18 + TypeScript + Node.js 的全栈解决方案
🎯 一键部署 - 支持 Steam 平台多款热门游戏的快速部署
🌐 Web 管理界面 - 基于 Ant Design 的现代化管理面板，响应式设计
🔧 实时终端 - 集成 Xterm.js 的 Web 终端，支持实时命令执行和日志查看
📊 资源监控 - 实时监控服务器资源使用情况和游戏实例状态
🔐 权限管理 - 基于 JWT 的用户认证和权限控制系统
🎮 多游戏支持 - 支持 40+ 款 Steam 游戏服务端，持续更新
💾 数据持久化 - 游戏数据和配置文件统一管理，安全可靠
🔌 WebSocket 通信 - 实时双向通信，即时状态更新
📦 Docker 支持 - 完整的容器化部署方案，一键启动
🎨 可视化配置 - 游戏配置文件的图形化编辑界面

本地开发部署

标准部署（x86_64）

# 安装依赖
npm run install:all

# 开发模式运行
npm run dev

# 生产模式构建
npm run package:<windows/linux>

ARM64 架构部署

如果您在 ARM64 架构的系统上开发，或需要在 x86_64 系统上通过 QEMU 模拟 ARM64 环境：

环境准备

# 安装 QEMU 用户模式模拟器
sudo apt-get install qemu-user-static

# 安装 ARM64 交叉编译库
sudo apt-get install libc6-dev-arm64-cross

# 确保 ARM64 Node.js v20.19.0 已安装到指定路径
# /home/xiaozhu/qemu/Node/node-v20.19.0-linux-arm64/

一键启动

# 安装所有依赖并启动双终端开发环境（推荐）
./start-arm64.sh

# 或者仅启动开发环境（假设依赖已安装）
./dev-arm64.sh

# 其他选项
./start-arm64.sh install    # 仅安装依赖
./start-arm64.sh dev-dual   # 双终端模式（推荐）
./start-arm64.sh dev-simple # 后台模式
./start-arm64.sh help       # 显示帮助信息

详细的 ARM64 部署说明请参考 scripts/arm/README.md

🏗️ 技术架构

前端技术栈

React 18 - 现代化前端框架，支持并发特性
TypeScript - 类型安全的 JavaScript 超集
Ant Design 5 - 企业级 UI 组件库
Zustand - 轻量级状态管理库
Monaco Editor - VS Code 同款代码编辑器
Xterm.js - 功能完整的 Web 终端模拟器
Socket.IO Client - 实时双向通信客户端
Framer Motion - 流畅的动画库
Vite - 极速构建工具
TailwindCSS - 原子化 CSS 框架

后端技术栈

Node.js 18+ - 高性能 JavaScript 运行时
TypeScript - 类型安全的服务端开发
Express.js - 轻量级 Web 框架
Socket.IO - 实时双向通信服务端
JWT - JSON Web Token 认证
Winston - 专业级日志系统
Multer - 文件上传处理
Node-cron - 定时任务调度
Axios - HTTP 客户端
Joi - 数据验证库

系统集成

SteamCMD - Steam 命令行工具
Docker - 容器化部署
PTY - 伪终端支持（跨平台）
File System - 统一文件管理系统

📁 项目结构

GSManager3/
├── client/                     # 前端应用
│   ├── src/                   # React + TypeScript 源码
│   │   ├── components/        # 可复用组件
│   │   ├── pages/            # 页面组件
│   │   ├── stores/           # Zustand 状态管理
│   │   ├── types/            # TypeScript 类型定义
│   │   ├── utils/            # 工具函数
│   │   └── config/           # 配置文件
│   ├── public/               # 静态资源
│   └── package.json          # 前端依赖
├── server/                    # 后端服务
│   ├── src/                  # Node.js + TypeScript 源码
│   │   ├── routes/           # API 路由
│   │   ├── modules/          # 功能模块
│   │   │   └── game/         # 游戏管理模块
│   │   ├── middleware/       # 中间件
│   │   ├── utils/            # 工具函数
│   │   └── Python/           # Python 脚本
│   ├── data/                 # 数据存储目录
│   │   ├── games/            # 游戏数据
│   │   └── plugins/          # 插件数据
│   ├── PTY/                  # 伪终端程序
│   └── package.json          # 后端依赖
├── scripts/                   # 构建脚本
├── docker-compose.yml         # Docker 编排文件
├── Dockerfile                # Docker 镜像构建文件
└── package.json              # 项目根依赖

🤝 贡献流程

贡献者准则

我们不限制您使用AI等辅助工具对代码进行贡献，若您使用AI参与开发请确保您的编辑器已导入项目规则，项目规则在根目录下的.trae文件夹内的.md文件中
不得提交具有后门，入侵操作系统等严重违规违法故意破坏使用者计算机的行为！
请确保您提交的代码清晰标注注释，变量请使用驼峰命名法。
代码逻辑不能采用非常简单粗暴的行为，应当评估代码在正式环境中对系统性能影响程度，始终要把性能消耗降到最低。

贡献流程

确保代码符合准则，没有语法错误。然后发起PR请求提交到本仓库的main分支。并详细说明代码功能和实现或修复的地方。
自动化审查脚本将会对您提交的代码进行基准检查，通过后将会自动合并到feature分支后需要等待作者进行最终功能和代码审核
审核通过后将会合并到main（主分支）并在您的PR告知您已通过最终审核。根据内容量和影响程度会评估最终发包时间，一般不超过7天。

特殊情况处理

若您代码提交后发现存在问题，届时您也没看到通过最终审核您需要确保提交的远程分支为feature以确保仓库的同步

一般情况在自动化审核通过后此PR会自动修改为feature分支

📞 支持与反馈

🐛 问题反馈：GitHub Issues
💬 QQ交流群：1040201322
📖 详细文档：GSM3 文档站
🌐 官方网站：GSM3 官网
💝 赞助支持：爱发电

📄 开源协议

本项目采用 GPL-3.0 license 开源协议。

👨‍💻 关于作者

此项目由 又菜又爱玩的小朱 独立开发维护。

如果这个项目对你有帮助，请给个 ⭐ Star 支持一下！

🔄 版本说明

GSM3.0 - 全新架构，基于 React + TypeScript + Node.js
GSM2.0 - 基于 Python + Flask 的经典版本查看源码
GSM1.0 - 游戏容器查看源码

主要更新

✅ 全新的现代化 Web 界面
✅ TypeScript 全栈开发，类型安全
✅ 实时 WebSocket 通信
✅ 游戏配置可视化编辑
✅ 更好的性能和稳定性
✅ 完整的 Docker 支持
✅ 跨平台兼容性

📈 项目统计

🎮 让游戏服务器管理变得简单有趣！

GSM3.0 - 新一代游戏服务器管理平台

🌐 官网 | 📖 文档 | 💬 交流群

README.md Unescape Escape