Contributing¶

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Where to start?¶

If you are looking for a good issue to start with, please check the following:

• good first issue - issues that should be pretty simple to implement,
• help wanted - issues that typically are a bit more involved than beginner issues,
• high priority - things to fix ASAP but often of higher complexity.

Source¶

To build from source on your local machine, please follow the instructions below:

Clone the repository¶

gitclonehttps://github.com/EndstoneMC/endstone.git
 cdendstone

Install the package manager (conan)¶

The dependencies needed for the development of Endstone are provided Conan Package Manager (>=2.0). The install the package manager, run the following commands in your Python environment.

pipinstallconan
conanprofiledetect

Install dependencies¶

First of all, run the following commands to install dependencies of this project:

Command Prompt

conaninstall.--build=missing-scompiler.cppstd=20-ctools.cmake.cmaketoolchain:generator=Ninja

Powershell

conaninstall.--build=missing-scompiler.cppstd=20-ctools.cmake.cmaketoolchain:generator=Ninja-ctools.env.virtualenv:powershell=True

Linux

conaninstall.--build=missing-scompiler.cppstd=20-scompiler.libcxx=libc++-ctools.cmake.cmaketoolchain:generator=Ninja

Now, activate the build virtual environment create by conan.

Command Prompt

.\build\Release\generators\conanbuild.bat

Powershell

.\build\Release\generators\conanbuild.ps1

Linux

 source./build/Release/generators/conanbuild.sh

Run cmake and check the version:

$cmake--version
cmakeversion3.31.2

Build with CMake¶

cmake--presetconan-release
cmake--build--presetconan-release

Install¶

To install Endstone from your local sources, simply run:

pipinstall-U.

Documentation¶

We are building our documentation using Material for MkDocs. The easiest way to install all the required dependencies is with pip:

pipinstall-rdocs/requirements.txt

After that, you can either:

• Start a live server to preview the documentation as you write, or

mkdocsserve

• Build the documentation

mkdocsbuild

Comments