forked from mirror/MCSM-Daemon
Update README.md
This commit is contained in:
Unitwk
GitHub
parent
eca0f79bc2
commit
837bbdca02
82
README.md
82
README.md
@ -1,4 +1,4 @@
|
||||
<img src="https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/logo.png" alt="MCSManager 图标.png" width="500px" />
|
||||
<img src="https://public-link.oss-cn-shenzhen.aliyuncs.com/mcsm_picture/logo.png" alt="MCSManager icon.png" width="500px" />
|
||||
|
||||
<br />
|
||||
|
||||
@ -6,91 +6,73 @@
|
||||
[](https://nodejs.org/en/download/)
|
||||
[](https://github.com/Suwings/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)
|
||||
English | [简体中文](readme_cn.md)
|
||||
|
||||
适用于 MCSManager 的分布式守护进程程序，与面板端分离直接管理和控制真实程序。
|
||||
[Official Website](http://mcsmanager.com/) | [Usage Documentation](https://docs.mcsmanager.com/) | [Team Homepage](https://github.com/MCSManager) | [MCSManager Project](https://github.com/MCSManager/MCSManager)
|
||||
|
||||
项目主仓库请前往：[https://github.com/MCSManager/MCSManager](https://github.com/MCSManager/MCSManager)
|
||||
A distributed daemon program for MCSManager, separate from the panel side to directly manage and control the real program.
|
||||
|
||||
Please go to the main project repository: [https://github.com/MCSManager/MCSManager](https://github.com/MCSManager/MCSManager)
|
||||
|
||||
<br />
|
||||
|
||||
## MCSManager 简介
|
||||
## Introduction to MCSManager
|
||||
|
||||
**分布式，稳定可靠，开箱即用，高扩展性，支持 Minecraft 和其他少数游戏的控制面板。**
|
||||
**Distributed, stable and reliable, out-of-the-box, highly scalable, support control panel for Minecraft and few other games. **
|
||||
|
||||
MCSManager 面板（简称：MCSM 面板）是一款全中文，轻量级，开箱即用，多实例和支持 Docker 的 Minecraft 服务端管理面板。
|
||||
The MCSManager panel (referred to as: MCSM panel) is an all-Chinese, lightweight, out-of-the-box, multi-instance and Docker-supported Minecraft server management panel.
|
||||
|
||||
此软件在 Minecraft 和其他游戏社区内中已有一定的流行程度，它可以帮助你集中管理多个物理服务器，动态在任何主机上创建游戏服务端，并且提供安全可靠的多用户权限系统，可以很轻松的帮助你管理多个服务器。
|
||||
This software has a certain popularity in Minecraft and other gaming communities, it can help you centrally manage multiple physical servers, dynamically create game servers on any host, and provide a secure and reliable multi-user permission system that can be easily Easily help you manage multiple servers.
|
||||
|
||||
<br />
|
||||
|
||||
## 项目状态
|
||||
## project status
|
||||
|
||||
项目处于发行状态，如果想促进开发或关注进度您可以点击右上角的 `star` `watch` 给予我们基本的支持。
|
||||
The project is in the release state. If you want to promote development or follow the progress, you can click `star` `watch` in the upper right corner to give us basic support.
|
||||
|
||||
若您想成为本项目的赞助者，请访问官方网站浏览至最底下。
|
||||
If you want to become a sponsor of this project, please visit the official website and browse to the bottom.
|
||||
|
||||
<br />
|
||||
|
||||
## 手动安装
|
||||
## Manual installation
|
||||
|
||||
先决条件：需要安装[Web 端程序](https://github.com/MCSManager/MCSManager-Web-Production)才能正常使用本软件。
|
||||
Prerequisite: [Web-side program](https://github.com/MCSManager/MCSManager-Web-Production) needs to be installed to use this software normally.
|
||||
|
||||
安装 `Node 14+` 与 `npm` 工具，并克隆[部署用 Daemon 代码](https://gitee.com/mcsmanager/MCSManager-Daemon-Production)，然后使用以下命令初始化并启动 Daemon 端。
|
||||
Install `Node 14+` and `npm` tools and clone the [Daemon code for deployment](https://gitee.com/mcsmanager/MCSManager-Daemon-Production), then use the following commands to initialize and start the Daemon side.
|
||||
|
||||
> 名词 Daemon 中文代表“守护进程”之意，在此处代表本地或远程主机的守护进程，用于真实运行服务端程序的进程，Web 端面板用于管理与调控，不与服务端程序实际文件进行任何接触。
|
||||
> The noun Daemon means "daemon process" in Chinese, here it represents the daemon process of the local or remote host, which is used to actually run the process of the server program. The web panel is used for management and control, not the actual file of the server program. make any contact.
|
||||
|
||||
```bash
|
||||
# cd MCSManager-Daemon-Production
|
||||
npm install
|
||||
node app.js
|
||||
```
|
||||
````
|
||||
|
||||
程序会输出以下内容
|
||||
The program will output the following
|
||||
|
||||
```log
|
||||
访问地址 localhost:24444
|
||||
访问密钥 [你的密钥，是一串16进制数字]
|
||||
密钥作为守护进程唯一认证手段
|
||||
```
|
||||
````log
|
||||
Access address localhost:24444
|
||||
access key [your key, a string of hexadecimal numbers]
|
||||
The key is the only means of authentication for the daemon
|
||||
````
|
||||
|
||||
使用密钥在 web 端添加实例即可。
|
||||
如需停止直接输入:
|
||||
Just add an instance on the web side using the key.
|
||||
To stop direct input:
|
||||
|
||||
```bash
|
||||
exit
|
||||
```
|
||||
Ctrl+C
|
||||
````
|
||||
|
||||
如需长期后台运行请使用 `Screen` 软件配合使用，或者手动写入到系统服务。
|
||||
If you need to run in the background for a long time, please use the `Screen` software in conjunction with it, or manually write to the system service.
|
||||
|
||||
<br />
|
||||
|
||||
## 贡献
|
||||
## Contribute
|
||||
|
||||
如果你在使用过程中发现任何问题，可以提交 Issue 或自行 Fork 修改后提交 Pull Request。
|
||||
If you find any problems during use, you can submit an Issue or submit a Pull Request after fork modification.
|
||||
|
||||
代码需要保持现有格式，不得格式化多余代码，具体可[参考这里](https://github.com/MCSManager/MCSManager/issues/544)。
|
||||
The code needs to keep the existing format, and no redundant code should be formatted. For details, please refer to [here](https://github.com/MCSManager/MCSManager/issues/544).
|
||||
|
||||
<br />
|
||||
|
||||
## 版权约束
|
||||
|
||||
此开源项目使用 [AGPL 协议](LICENSE) 作为开源协议，未经过官方闭源开发授权，您如果对代码有任何修改，则必须要公开您修改后的源代码，具体约束如下。
|
||||
|
||||
**准许**
|
||||
|
||||
- 对软件源代码进行修改，复制，分发。
|
||||
- 利用软件进行商业使用，赚取利润。
|
||||
|
||||
**必须**
|
||||
|
||||
- 公开提供您修改后的完整源代码。
|
||||
- 在代码文件、界面中保留版权声明。
|
||||
|
||||
**禁止**
|
||||
|
||||
- 禁止售卖此软件，申请专利，著作权等。
|
||||
|
||||
> 更多授权与版权约束详情，请前往官方网站界面了解更多。
|
||||
|
||||
<br />
|
||||
|
||||
Loading…
Reference in New Issue
Block a user