快速上手¶

这是一个 MCDReforged （简称为 MCDR，下同）的快速上手教程。

依赖¶

MCDR 依赖 python3 运行环境。请确保你的 python 版本大于 3.6。

MCDR 在 pypi 中可用。它可以通过 pip 命令安装：

pip install mcdreforged

对于国内用户，你可以在 pip 指令的末尾添加 -i https://pypi.tuna.tsinghua.edu.cn/simple 后缀来使用清华 pypi 镜像来加速 MCDR 的下载安装。

pip install mcdreforged -i https://pypi.tuna.tsinghua.edu.cn/simple

假设你想在 my_mcdr_server 文件夹中运行 MCDR，那么你可以运行以下指令：

cd my_mcdr_server
python -m mcdreforged

在首次启动时，MCDR 会生成默认的配置文件、权限文件，以及一些默认的文件夹。此时的路径结构将会如下所示：

my_mcdr_server/
 ├─ config/
 ├─ logs/
 │   └─ MCDR.log
 ├─ plugins/
 ├─ server/
 ├─ config.yml
 └─ permission.yml

现在，把你的服务端文件放入服务端文件夹里（默认为 server 文件夹），然后修改配置文件 config.yml 以及权限文件 permission.yml 以满足你的需求。完成后，你可以再次启动 MCDR，这次它将正确地启动并操控服务器运行了。

python -m mcdreforged

在 pypi 的帮助下，MCDR 可以轻松地通过这个命令升级：

pip install mcdreforged --upgrade

就酱！

如果你是国内用户，你同样可以借助清华 pypi 镜像来加速 MCDR 的升级：

pip install mcdreforged --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

开发版本可在 Test PyPi 中找到。如果你有特殊需要，你可以安装它们。

除了借助 pypi 进行安装，你还可以直接从源代码执行 MCDR。

在 Github 发布页面中下载 MCDR 源代码，并解压到你的服务器文件夹

my_mcdr_server/
 ├─ mcdreforged/
 │   └─ ..
 ├─ MCDReforged.py
 └─ ..

然后就可以使用和同上所述的指令启动 MCDR：

python -m mcdreforged

当然你也可以通过运行 MCDReforged.py 来启动 MCDR：

python MCDReforged.py

MCDReforged.py 只是一个简单的启动 MCDR 的包装，它的代码如下所示

import sys

from mcdreforged.__main__ import main

if __name__ == '__main__':
    sys.exit(main())

运行 MCDReforged.py 同样适用于从 pypi 安装的 MCDR。

对于 Windows 用户，如果你已将 *.py 文件的打开方式绑定到了一个正确的 Python 解释器，那么你也可以双击 MCDReforged.py 来启动 MCDR。