Skip to content

Getting started

Endstone offers a powerful plugin API for Bedrock Dedicated Servers, the official server software for Minecraft: Bedrock Edition. If you're familiar with Python, you can install Endstone with pip, the Python package manager. If not, we recommend using docker.

Installation

Environment optional

We recommend using a virtual environment, which is an isolated Python runtime. If you are in a virtual environment, any packages that you install or upgrade will be local to the environment. If you run into problems, you can just delete and recreate the environment. It's trivial to set up:

  • Create a new virtual environment with:

    python3 -m venv venv

  • Activate the environment with:

    . venv/Scripts/activate

    . venv/bin/activate

    Your terminal should now print (venv) before the prompt, which is how you know that you are inside the virtual environment that you just created.

  • Exit the environment with:

    deactivate

with pip recommended

Endstone is published as a Python package and can be installed with pip, ideally by using the virtual environment from the last step. Open up a terminal and install Endstone with:

pip install endstone

with docker

The official Docker image is a great way to get the Endstone server up and running in a few minutes. Open up a terminal and pull the image with:

docker pull endstone/endstone

Comments