Skip to content

Latest commit

 

History

History
139 lines (82 loc) · 3.58 KB

quick_start.rst

File metadata and controls

139 lines (82 loc) · 3.58 KB
Raw

Quick Start

This is a quick start tutorial of MCDReforged (abbreviated as MCDR, omitted below)

Requirements

MCDR requires Python3 runtime. The Python version need to be at least 3.8. The detailed Python version requirements are as shown in the table below

MCDR version Python requirement
< 2.10 >= 3.6
>= 2.10 >= 3.8

Install

MCDR is available in pypi, which means it can be installed via the pip command:

Windows

pip install mcdreforged

Linux

pip3 install mcdreforged

For Chinese users, you can added a -i https://pypi.tuna.tsinghua.edu.cn/simple prefix to the command to use Tsinghua tuna mirror to speed up the installation:

Windows

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

Linux

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

DO NOT download the source files of MCDR and execute them directly, unless you're a developer of MCDR and you know what you are doing

After MCDR has been installed using pip, you can verify the installation with the following command:

bash

$ mcdreforged MCDReforged v@@MCDR_VERSION@@

Start up

Let's say your are going to start MCDR in a folder named my_mcdr_server. Then you can run the following commands to initialize the environment for MCDR first:

cd my_mcdr_server
mcdreforged init

MCDR will generated the default configuration and permission files, as well as some default folders. The file structure will be like this

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

Now put your server files into the server folder (server by default), then modify the configuration file config.yml and permission file permission.yml correctly

After that you can launch MCDR, and it will start handling the server correctly

mcdreforged

Upgrade

With the help of pypi, MCDR can be easily upgraded via a single command

Windows

pip install mcdreforged -U

Linux

pip3 install mcdreforged -U

That's it!

For Chinese users, you can use tuna mirror to speed up the upgrading too

Windows

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

Linux

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

Development builds are available in Test PyPi, you can install them if you have special needs

Next

Now, you've got the basics of how to set up, run, and upgrade MCDR. What's next? Feel free to check out other parts of the documentation

  • Check how to configure MCDR: /configuration
  • Discover the MCDR command system: /command
  • Take a look at MCDR's built-in permission system: /permission
  • Learn more about MCDR command line interface: /plugin_dev/cli
  • Dive into the document to explore more about MCDR ...