MCSManager/README_CN.md

MCSManager Panel

官方网站 | 使用文档 | QQ 群 | TG 群 | 成为赞助者

English | 简体中文

这是什么？

MCSManager 面板（或简称：MCSM 面板）是一款开源，分布式，轻量级，快速部署，支持大部分游戏服务端和控制台程序的管理面板。

此软件在 Minecraft 和其他游戏社区内中已有一定的流行程度，它可以帮助你集中管理多个物理服务器，实现在任何主机上创建游戏服务器，并且提供安全可靠的多用户权限系统，可以很轻松的帮助你管理多个服务器，一直在为 Minecraft，Terraria 和 Steam 游戏服务器的管理员，运维人员和个人开发者提供健康的软件支持。

功能特性

1. 支持一键架设 Minecraft Java 版/基岩版游戏服务器。
2. 兼容大部分 Steam 游戏服务器，列如 幻兽帕鲁，战术小队，僵尸毁灭工程 和 泰拉瑞亚 等。
3. 可自定义网页 UI 界面设计，打造自己喜欢的界面样式。
4. 支持 Docker 虚拟化，支持多用户，支持商业出租行为。
5. 支持分布式，一个网页即可同时管理数台机器。
6. 更多...

运行环境

控制面板可运行在 Windows 与 Linux 平台，无需安装数据库，只需安装 NodeJS 环境和几个用于解压缩的命令。

必须 NodeJS 16.20.2 以上。

安装

Windows

对于 Windows 系统，已整合成直接运行版本，下载即可运行:

前往：https://mcsmanager.com/

Linux

一行命令快速安装

// 国内用户专用 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 手动安装

• 若一键安装不起作用，则可以尝试此步骤手动安装。

# 切换到安装目录。如果不存在，请提前用'mkdir /opt/'创建它。
cd /opt/
# 下载运行时环境（Node.js）。如果你已经安装了Node.js 14+，请忽略此步骤。
wget https://nodejs.org/dist/v20.11.0/node-v20.11.0-linux-x64.tar.xz
# 解压档案
tar -xvf node-v20.11.0-linux-x64.tar.xz
# 添加程序到系统环境变量
ln -s /opt/node-v20.11.0-linux-x64/bin/node /usr/bin/node
ln -s /opt/node-v20.11.0-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 软件来管理，如果你希望由系统服务来接管 MCSManager，请参考文档。

浏览器兼容性

• 支持 Chrome Firefox Safari Opera 等现代主流浏览器。
• 已放弃支持 IE 浏览器。

国际化

MCSManager 已支持中文，英文两种语言，后期可以兼容更多语言，已经实现国际化全面覆盖。

翻译和软件国际化由 KevinLu2000，Lazy，zijiren233 和 Unitwk 共同完成，在此感谢这些贡献者们。

搭建开发环境

此段落面向开发人员，普通用户无需关注也无需执行。

MacOS

git clone https://github.com/MCSManager/MCSManager.git
./install-dependents.sh
./npm-dev-macos.sh

Windows

git clone https://github.com/MCSManager/MCSManager.git
./install-dependents.bat
./npm-dev-windows.bat

构建生产环境版本

./build.bat
# 或者
./build.sh

贡献代码

如果你在使用过程中发现任何问题，可以 提交 Issue 或自行 Fork 修改后提交 Pull Request。

代码需要保持现有格式，不得格式化多余代码，具体可参考这里。

BUG 报告

欢迎发现的任何问题进行反馈，必当及时修复。

若发现严重安全漏洞又不便公开发布，请发送邮件至: mcsmanager-dev@outlook.com，安全问题修复后将在代码中附加漏洞发现者姓名。

源代码协议

源代码遵循 Apache-2.0 协议。

Copyright 2024 MCSManager.