快速上手

这是一个 MCDReforged (简称为 MCDR,下同)的快速上手教程

依赖

MCDR 依赖 Python3 运行环境。请确保你的 Python 版本大于 3.8。具体的 Python 版本需求如下表所示

MCDR 版本

Python 依赖

< 2.10

>= 3.6

>= 2.10

>= 3.8

安装

MCDR 已于 pypi 中发布,因此你可以通过 pip 命令来安装 MCDR:

pip install mcdreforged
pip3 install mcdreforged

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

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

不要 直接下载 MCDR 的源代码并从中启动 MCDR,除非你是一个知道你自己在做什么的 MCDR 开发者

在使用 pip 安装 MCDR 后,你可以用以下指令来验证安装是否成功:

$ mcdreforged
MCDReforged v2.12.3

启动

假设你想在 my_mcdr_server 这一个文件夹中运行 MCDR,那么你可以运行以下指令以初始化 MCDR 的运行环境:

cd my_mcdr_server
mcdreforged init

MCDR 将生成默认的配置文件、权限文件,以及一些默认的文件夹。此时的路径结构将会如下所示:

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

现在,把你的服务端文件放入服务端文件夹里(默认为 server 文件夹),然后修改配置文件 config.yml 以及权限文件 permission.yml 以满足你的需求

完成后,你就可以启动 MCDR,它将开始正确地操控服务器运行

mcdreforged

更新

pypi 的帮助下,MCDR 可以轻松地通过这个命令升级:

pip install mcdreforged -U
pip3 install mcdreforged -U

就酱!

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

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

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

下一步

现在,你已经掌握了部署、运行以及升级 MCDR 的方法。接下来,你可以进一步探索文档的其他部分

  • 查看配置 MCDR 的方式:配置

  • 探索 MCDR 的命令系统:指令

  • 了解 MCDR 的内置权限系统:权限

  • 学习更多关于 MCDR 命令行接口的信息:命令行接口

  • 深入文档以探索更多关于 MCDR 的内容……