跳转至

贡献

来源信息

👍🎉 首先，感谢您花时间做出贡献！🎉👍

从哪里开始？

如果您在寻找一个好的问题来开始，请检查以下内容：

源代码

要在本地机器上从源代码构建，请按照以下说明进行操作：

克隆仓库

git clone https://github.com/EndstoneMC/endstone.git
cd endstone

安装包管理器(conan)

开发Endstone所需的依赖项由Conan包管理器(>=2.0)提供。要安装包管理器，请在Python环境中运行以下命令。

pip install conan
conan profile detect

安装依赖

首先，运行以下命令来安装该项目的依赖项：

=== " 命令提示符" 

conan install . --build=missing -s compiler.cppstd=20 -c tools.cmake.cmaketoolchain:generator=Ninja

=== " Powershell" 

conan install . --build=missing -s compiler.cppstd=20 -c tools.cmake.cmaketoolchain:generator=Ninja -c tools.env.virtualenv:powershell=True

=== " Linux"

```shell
conan install . --build=missing -s compiler.cppstd=20 -s compiler.libcxx=libc++ -c tools.cmake.cmaketoolchain:generator=Ninja
```

现在，激活由conan创建的构建虚拟环境。

=== " 命令提示符" 

.\build\Release\generators\conanbuild.bat

=== " Powershell" 

.\build\Release\generators\conanbuild.ps1

=== " Linux"

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

运行cmake并检查版本：

$ cmake --version
cmake version 3.31.2

使用CMake构建

cmake --preset conan-release
cmake --build --preset conan-release

安装

要从本地源安装Endstone，只需运行：

pip install -U .

文档

我们使用Material for MkDocs构建文档。 安装所有必需依赖项的最简单方法是使用pip：

pip install -r docs/requirements.txt

之后，您可以选择：

mkdocs serve

mkdocs build

评论