Update README.md

This commit is contained in:
Suwings 2017-12-11 17:24:52 +08:00 committed by GitHub
parent f7cb97e5d8
commit f3e92ad802
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,20 +1,24 @@
# Minecraft Server Manager
Minecraft Server Manager
-----------
简单,易用,简约,轻量级的 Minecraft Server 控制面板
# 快速扩展
快速扩展
-----------
我们用最简单上手的方式,来构建整个应用程序,绝大部分的开发者可以轻而易举的进行修改,以及依照协议开发使用。你会发现,这可能是一非常适合你的 `Minecraft` 服务器管理工具,支持绝大部分的主流服务端。
并且,我们将尽可能的降低扩展的学习成本来帮助你更好的扩展与自定义,让一个完全属于你的`Minecraft`服务器管理器出现。
# 环境需求
环境需求
-----------
- `Node.js` >= 8.0
- `Java` >= 7.0 但强烈推荐 `Java` >= 8
# 运行在 Windows 平台
运行在 Windows 平台
-----------
### 方法一
- 方法一
下载并正确安装 `Node` 8 环境: [https://npm.taobao.org/mirrors/node/v8.0.0/](https://npm.taobao.org/mirrors/node/v8.0.0/)
@ -29,16 +33,16 @@
执行命令 `node app.js``npm start`
### 方法二
- 方法二
介于某些原因,您可能并不愿意安装这些运行环境,于是我们给予了一种绿色打包的运行环境,下载即可直接使用
下载直接双击运行: https://pan.baidu.com/s/1bpbB8Az (下载地址)
# 运行在 Linux 平台
-相对而言,这可能更加简单
运行在 Linux 平台
-----------
- 相对而言,这可能更加简单
```bash
git clone https://github.com/Suwings/MCSManager.git
@ -47,7 +51,9 @@ npm install --production
node app.js #或 npm start
```
# 项目目录结构
项目目录结构
-----------
**注意:** 并不是所有目录的文件我们都建议你进行更改!
| 目录名 | 详情/解释 |
| ------------------------ | --------------------------------------------------------------------------------------------- |
@ -65,10 +71,13 @@ node app.js #或 npm start
| **helper/**                     |业务逻辑辅助层,通常控制器会使用这些,列如权限判定之类|
| **ftpd/**                       |FTP 功能模块,其中 ftpserver.js 已经实现了抽象 ftpServerInterface 接口|
# Bug 报告
欢迎各位发现任何 BUG 及时反馈给我,必当及时修复。
Bug 报告
-----------
欢迎各位发现任何 BUG 及时反馈给我,必当及时修复
# 开源协议与版权
开源协议与版权
-----------
程序是基于 [GNU Affero General Public License v3.0](./LICENSE "GNU Affero General Public License v3.0") 开放源代码的自由软件,你可以遵照 AGPLv3 协议来修改和重新发布这一程序。