![logo.png](http://39.108.57.206/public/MCSM_LOGO_1.png) ![doc_logo.png](/public/common/doc_logo.png) [![Status](https://img.shields.io/badge/npm-v4.16.3-blue.svg)](https://www.npmjs.com/) [![Status](https://img.shields.io/badge/node-v8.0-blue.svg)](https://nodejs.org/en/download/) [![Status](https://img.shields.io/badge/Linux-passing-brightgreen.svg)](https://github.com/Suwings/MCSManager) [![Status](https://travis-ci.org/Suwings/MCSManager.svg?branch=master)](https://travis-ci.org/Suwings/MCSManager) [![Status](https://img.shields.io/badge/License-AGPLv3-red.svg)](https://github.com/Suwings/MCSManager) 简单，易用，多实例，轻量级的 Minecraft Server 控制面板 [中文简体](Readme.md) | [中文繁體](README-traditional.md)
欢迎使用 ----------- ![软件截图](http://39.108.57.206/public/MCSM_A.png) **注意:** 因为不定时更换原因，目前截图不一定最新。
快速扩展 ----------- 我们用最简单上手的方式，来构建整个应用程序，绝大部分的开发者可以轻而易举的进行修改，以及依照协议开发使用。你会发现，这可能是一非常适合你的 `Minecraft` 服务器管理工具，支持绝大部分的主流服务端。 并且，我们将尽可能的降低扩展的学习成本来帮助你更好的扩展与自定义，让一个完全属于你的`Minecraft`服务器管理器出现。
运行环境 ----------- - 我们的部署简单至极，在`Master`分支下，我们的设计是下载即可运行，不需要编译与任何配置，除了安装一个环境。 - `Node.js` >= 8.0 - `下载镜像站点`: [https://npm.taobao.org/mirrors/node/v8.0.0/](https://npm.taobao.org/mirrors/node/v8.0.0/)
演示环境 ----------- - 地址: [https://link.suwings.top/](https://link.suwings.top/) - 账号: `public` 密码: `123456` - 账号: `public2` 密码: `1234567` - 账号: `#master` 密码: `<暂不开放>` > 仅仅开放普通账号给予演示，管理账号不开放，想了解更多，请下载体验。
运行在 Windows ----------- **方法一 (仅限中文简体)** 下载并正确安装 `Node` 环境: 下载源代码并解压: [https://github.com/Suwings/MCSManager/archive/master.zip](https://github.com/Suwings/MCSManager/archive/master.zip) 进入程序源代码目录，并且在当前目录打开命令控制台 执行命令 `npm install --production` 执行命令 `node app.js` 或 `npm start` **方法二 (包含简体/繁体版本)** 可能因为某些原因，您可能并不愿意安装这些运行环境，于是我们给予了一种绿色打包的运行环境，下载即可直接使用。 下载直接运行: https://pan.baidu.com/s/1bpbB8Az (中文简体/繁体中文版本 下载地址) **注意:** 百度网盘提供的下载是打包集成好的，小版本更新我们不会打包，也就是意味着，这里不能实时跟随最新版本。
运行在 Linux ----------- - 相对而言，这可能更加简单。保证您的 node 版本正确与 git 工具可行下，安装与运行易如反掌。 ```bash git clone https://github.com/Suwings/MCSManager.git cd MCSManager npm install --production node app.js #或 npm start ``` > 如果您还是无法运行，请 [单击这里](https://github.com/Suwings/MCSManager/wiki/Linux-%E4%B8%8B%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E8%AF%A6%E8%A7%A3)
Wiki --------- 我们有些常见问题与细节上的问题，已经把它们都整合在 `Wiki` 里面。 欢迎你阅读 [Wiki](https://github.com/Suwings/MCSManager/wiki) 与提出建议。
项目目录结构 ----------- **注意:** 并不是所有目录的文件我们都建议你进行更改！ | 目录名 | 详情/解释 | | ------------------------ | --------------------------------------------------------------------------------------------- | | **property.js** |控制面板配置文件| | **core/logo.txt**               |控制台输出 logo 文字| | **public/** |前端所有代码，资源目录，前后端分离，使用 ws 和 ajax 通讯| | **public/login/**               |纯 UI 逻辑登陆页面| | **public/template/**             |前端业务模板，每个模板拥有着一个生命周期，开始与结束。| | **public/onlinefs_public/**      |文件在线管理模块前端所有代码| | **public/common/js/meum.js** |控制面板左侧菜单列表| | **public/common/js/login.js** |通用登录流程逻辑，可重复利用在各类 HTML 登录模板| | **server/server_core**           |Minecraft 服务端核心目录，包括服务端文件，配置，Mod，以及插件| | **server/x.json**               |Minecraft 服务器面板配置文件| | **users/x.json**               |控制面板用户配置文件| | **route/**                     |控制器，HTTP 请求业务逻辑层（可二次扩展）| | **route/websocket/**            |控制器，Webscoket 请求业务逻辑层（可二次扩展）| | **core/Process/**               |Minecraft Server 类实现| | **core/User/**                   |User 类实现| | **core/DataModel.js**            |数据持久化模型，几乎是所有的配置的 I/O 模型| | **model/**                     |模型层，用于提供控制器与服务端，用户操作，也提供设计模式模型| | **helper/**                     |业务逻辑辅助层，用于辅助和重复利用业务逻辑| | **ftpd/**                       |FTP 独立模块，其中 ftpserver.js 已经实现了抽象 ftpServerInterface 接口| | **onlinefs/**                    |文件管理独立模块 ([Suwings/IndependentFileManager](https://github.com/Suwings/IndependentFileManager))|
浏览器兼容性 ----------- - `ECMAScript 5` 标准 - `IE 10+` `Chrome` `Firefox` `Safari` `Opera` 等现代主流浏览器 **例外:** 文件在线管理界面需要 `IE 11+`
配置文件 ----------- 我们的配置文件是程序目录下的 `property.js` 文件，它会在你第一次运行的时候，自动生成。 > 注意！原旧版本的 McserverConfig.json 文件完全弃用。 > 现在，所有配置将全部归纳于此文件。 > 此文件不会与 github 版本冲突，更新时也不会自动覆盖
自定义设计 ----------- 如果你是内部使用或学习用途，你可以对前端以及后端进行任何修改，包括版权声明。 > 注意！当你进行版本更新的时候，可能会覆盖掉你的自定义修改部分。 > 当然，并不是所有文件都需要覆盖一遍，也不一定非得使用新版本。
FTP 服务 ----------- FTP 模块采用被动传输模式，传输命令默认使用 `10022`(可更改) 端口； 传输数据需要一个端口段，默认是 `20010` - `20100`； 为确保 FTP 服务正常使用，请配置好您的防火墙设置，对这些端口范围进行开放。 > 当然，我们提供了在线文件管理功能，您大可不必完全使用 FTP。
反向代理 与 SSL ----------- 尽管默认没有 Https ，您可能在公共网络下不太放心，但是我们不传递明文的密码，可以保证你的账号的密码是难以泄露的。 具体密码传递过程可参考 [单击这里跳转](https://github.com/Suwings/MCSManager/wiki/%E7%99%BB%E5%BD%95%E5%AF%86%E7%A0%81%E4%BC%A0%E9%80%92%E8%BF%87%E7%A8%8B%E5%9B%BE) **Property 文件** 反向代理之前，你可以但不是必须阅读 `property.js` 文件 > 里面有各类的设置，包括 gzip压缩，端口和ip绑定等等。 **实现 HTTPS 与 WSS** 打开前端 URL 定位文件 `public/common/URL.js`, 将 http 与 ws 改成 https 与 wss； 可保证前端所有请求均为 https 和 wss > 此文件不会与 github 版本冲突，更新时也不会覆盖，请放心修改。 **反向代理** 后端请通过反向代理完成，或自行修改 Express 初始化 App。 **注意:** [Nginx 反向代理注意](https://github.com/Suwings/MCSManager/issues/22) | [Apache 反向代理注意](https://github.com/Suwings/MCSManager/issues/34)
虚拟化 ----------- **注意** 这是一个轻量级的管理面板，没有集成虚拟化容器，请注意提供陌生人服务端的风险。 但是你可以实现一个整体的虚拟化容器，以保证你的宿主机安全。 另外，在服务器启动时也有 `自定义启动命令(可禁止)` 功能，这可以让你启动服务器时不止是运行 java 相关命令，甚至可以运行命令脚本，对此你可以尝试更多的技巧组合，实现你的需求，列如，启动服务器时顺便启动一个脚本来做某些事情。 **整体的虚拟化** 尽管我们没有为每一个实例服务器都创建一个虚拟化容器，但是你可以为整个控制面板套一个整体上的虚拟化容器。 > 更多信息可参考 [Wiki](https://github.com/Suwings/MCSManager/wiki/Linux-Docker-%E6%95%B4%E4%BD%93%E5%8C%96%E8%A7%A3%E5%86%B3%E6%96%B9%E6%A1%88)
权限系统 ----------- 尤其注意的是，为了更加简化面板权限系统，我们只分为两种账号； `管理账号` 凡是以 # 字符开头的用户，均为管理账号，列如 `#master` `#admin` `#test` `普通账号` 不以 # 字符开头的用户，列如 `test` `usernameww` `xxx` 普通账号能够管理的服务器只能由管理账号来进行设定，管理账号可以管理任何服务器，并且能管理所有用户。 具体使用，我想你只需要运行就知道，设计的十分简单。
问题报告 ----------- 欢迎各位发现任何 BUG 及时反馈给我，必当及时修复
协议与版权 ----------- 程序是基于 [GNU Affero General Public License v3.0](./LICENSE "GNU Affero General Public License v3.0") 开放源代码的自由软件。 你可以遵照 AGPLv3 协议来修改和重新发布这一程序。 或者，在学习或私自 (内部) 使用时，在不公开发布的原则下，可以无视这个**协议和版权**，因为这本身并不能束缚你，并且我们欢迎这样做。