MCSManagerLogo.png
[![Status](https://img.shields.io/badge/npm-v6.14.15-blue.svg)](https://www.npmjs.com/) [![Status](https://img.shields.io/badge/node-v14.17.6-blue.svg)](https://nodejs.org/en/download/) [![Status](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://github.com/MCSManager) [官方网站](http://mcsmanager.com/) | [使用文档](https://docs.mcsmanager.com/) | [团队主页](https://github.com/MCSManager) | [面板端项目](https://github.com/MCSManager/MCSManager) | [网页前端项目](https://github.com/MCSManager/UI) | [守护进程项目](https://github.com/MCSManager/Daemon) 中文 QQ 群:https://jq.qq.com/?_wv=1027&k=Pgl9ScGw 中文 TG 群:https://t.me/MCSManager_dev 爱发电赞助:https://afdian.net/a/mcsmanager
## 这是什么? MCSManager 面板(简称:MCSM 面板)是一款开源,分布式,轻量级,快速部署,支持大部分游戏服务端和控制台程序的管理面板
## 软件特性 软件在 Minecraft 和其他游戏社区内中已有一定的流行程度,它可以帮助你集中管理多个物理服务器,动态在任何主机上创建游戏服务端,并且提供安全可靠的多用户权限系统,可以很轻松的帮助你管理多个服务器,一直在为 Minecraft,Terraria,Steam 游戏服务器管理员,运维人员和个人开发者提供健康的软件支持。 ![截图.png](https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/MCSM9.png) ![Screenshot.png](https://mcsmanager.com/main2.png) QQ20221207-174328@2x
## 运行环境 控制面板可运行在 Windows 与 Linux 平台,无需数据库与任何系统配置,只需安装 node 环境即可快速运行,属于轻量级的 Minecraft 服务端控制面板。 必须 `Node 14.17.0` 以上,无需数据库和更改任何系统配置,开箱即可运行。
## 配置/数据文件 配置文件: `data/SystemConfig/config.json` 用户数据文件:`data/User/*.json` 远程守护进程配置:`data/RemoteServiceConfig/*.json`
## 软件文档 地址:[https://docs.mcsmanager.com/](https://docs.mcsmanager.com/)
## 安装 ### Windows 对于 Windows 系统,**已整合成直接运行版本,下载即可运行**(使用管理员权限运行): 前往:[https://mcsmanager.com/](https://mcsmanager.com/) > 如果您需要将 MCSManager 面板注册到 Windows 系统服务,请点击[这里](https://github.com/bddjr/mcsmanager-services-for-windows)。
### Linux **一行命令快速安装** ```bash // 国内用户专用 gitee 加速源 wget -qO- https://gitee.com/mcsmanager/script/raw/master/setup_cn.sh | bash // 或原始源(科学上网) wget -qO- https://raw.githubusercontent.com/mcsmanager/Script/master/setup.sh | bash ``` - 脚本仅适用于 AMD64 架构 Ubuntu/Centos/Debian/Archlinux。 - 执行完成后,使用 `systemctl start mcsm-{web,daemon}` 即可启动面板服务。 - 面板代码与运行环境自动安装在 `/opt/mcsmanager/` 目录下。
**Linux 手动安装** - 若一键安装不起作用,则可以尝试此步骤手动安装。 ```bash # 切换到安装目录。如果不存在,请提前用'mkdir /opt/'创建它。 cd /opt/ # 下载运行时环境(Node.js)。如果你已经安装了Node.js 14+,请忽略此步骤。 wget https://nodejs.org/dist/v14.17.6/node-v14.17.6-linux-x64.tar.gz # 解压档案 tar -zxvf node-v14.17.6-linux-x64.tar.gz # 添加程序到系统环境变量 ln -s /opt/node-v14.17.6-linux-x64/bin/node /usr/bin/node ln -s /opt/node-v14.17.6-linux-x64/bin/npm /usr/bin/npm # 准备好安装目录 mkdir /opt/mcsmanager/ cd /opt/mcsmanager/ # 下载MCSManager wget https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz tar -zxf mcsmanager_linux_release.tar.gz # 安装依赖库 ./install-dependency.sh # 请打开两个终端或屏幕 # 先启动守护程序 ./start-daemon.sh # 启动网络服务(在第二个终端) ./start-web.sh # 为网络界面访问http://localhost:23333/ # 一般来说,网络应用会自动扫描并连接到本地守护进程。 ``` - 注意,这种安装方式不会自动注册面板到系统服务(Service),所以必须使用 `screen` 软件来管理。
## 更新版本 参考: https://github.com/MCSManager/MCSManager/wiki/Update-MCSManager > 如果你不是特别需要新版本的功能,或者不是为了修复安全隐患,那就不建议更新。
## 项目体系 整个软件运行需要三个项目的互相配合才可运行,您普通安装的代码是编译再整合后的产物。 [**控制面板端**](https://github.com/MCSManager/MCSManager) - 角色:控制中心 - 责任:负责提供网页前端的后端接口,提供 API 接口,用户数据管理和对守护进程进行通信和授权。 [**网页前端**](https://github.com/MCSManager/UI) - 角色:控制中心的用户交互界面 - 责任:以网页形式展示数据,发送请求,并且拥有与守护进程通信的能力,此项目最终产物是纯静态文件。 [**守护进程**](https://github.com/MCSManager/Daemon) - 角色:被控端 - 责任:控制本地主机的所有实例,真实进程的实际管理者,拥有与任何对象的通信能力。
## 搭建开发环境 此段落面向开发人员,普通用户无需关注也无需执行。 所有项目全部以开发环境运行后,便可以进行开发与预览,请务必遵循开源协议。 **控制面板端(MCSManager)** ```bash git clone https://github.com/MCSManager/MCSManager.git cd MCSManager npm install npm run start # 默认将采用 ts-node 直接执行 Typescript 代码 # 默认运行在 23333 端口 ``` **网页前端(UI)** ```bash git clone https://github.com/MCSManager/UI.git cd UI npm install npm run serve # 访问 http://localhost:8080/ 即可预览界面 # 所有 API 请求将自动转发到 23333 端口 ``` **守护进程(Daemon)** ```bash git clone https://github.com/MCSManager/Daemon.git cd Daemon npm install npm run start # 运行后请在控制面板端连接本守护进程 # 默认运行在 24444 端口 ```
## 浏览器兼容性 - 支持 `Chrome` `Firefox` `Safari` `Opera` 等现代主流浏览器。 - 已放弃支持 `IE` 浏览器。
## 国际化 MCSManager 已支持中文,英文两种语言,已经实现国际化全面覆盖。 软件国际化由 [Lazy](https://github.com/LazyCreeper),[KevinLu2000](https://github.com/KevinLu2000),[zijiren233](https://github.com/zijiren233) 和 [Unitwk](https://github.com/unitwk) 共同完成
## 贡献 如果你在使用过程中发现任何问题,可以 [提交 Issue](https://github.com/MCSManager/MCSManager/issues/new/choose) 或自行 Fork 修改后提交 Pull Request。 代码需要保持现有格式,不得格式化多余代码,具体可[参考这里](https://github.com/MCSManager/MCSManager/issues/544)。
## 问题报告 欢迎发现的任何问题进行反馈,必当及时修复。 若发现严重安全漏洞又不便公开发布,请发送邮件至: mcsmanager-dev@outlook.com。 安全问题修复后将在代码中附加漏洞发现者姓名。
## 源代码协议 源代码遵循 Apache-2.0 协议。 版权所有 2022 MCSManager 开发团队。