Repository files navigation

Endstone

Write your plugins in Python and C++ for Bedrock Dedicated Servers.

• 📖 Introduction
• 🎯 Features
• 🛠️ Get started
• 🌟 Plugins
• 🙌 Contributing
• 🎫 License

We are excited to announce the Endstone project. Endstone offers a plugin API for Bedrock Dedicated Servers, supportingboth Python and C++ languages. This allows developers to enhance Bedrock Dedicated Servers with various features andfunctionalities.

🏆This project is proudly sponsored byBisect Hosting.

• Cross-platform: We have dedicated efforts to support both Windows and Linux. Proudly, we are the onlyBDS-based server software sporting native support for both platforms without the need for an emulator.
• Feature-rich: All up-to-date Minecraft features are at your fingertips! We make sure to keep Endstone aligned withthe latest game updates.
• Hassle-free: Ready to use right out of the box. Start the Endstone server with just one line of command. No extratools required.
• High-level API: We provide a high-level friendly API akin to Bukkit plugin developers. Save yourself the hassle ofdealing with the dot-and-cross of the low-level system API and hooks, we've done the difficult part for you!
• Starter-friendly: No C++ knowledge? No problem! Craft your plugins using Python, your favourite.
• Performance-in-mind: For the performance savants, you can, of course, write (or rewrite) your plugins in C++ tosqueeze outevery bit of performance.

Before getting started, verify that you are using one of the following compatible operating systems:

• Windows 10 version 10.0.15063 or later
• Windows Server 2016 or later
• Debian 11 or later
• Ubuntu 20.04 or later

Please also ensure you havePython 3.9 or higher installed on your system.

There are several ways to install Endstone:

Endstone can be installed directly from PyPi using pip. Open your terminal and execute the following command to installand startthe Endstone server:

pip install endstoneendstone

Endstone can be easily installed on Linux using an autoinstaller script.

The autoinstaller supports the following operating systems and distributions based on them:

• Ubuntu
• Debian
• Fedora
• Arch Linux

You can use eitherwget orcurl to download the required scripts.

Usingwget:

wget https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/autoinstall.shsudo chmod +x autoinstall.shwget https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/start.shsudo chmod +x start.sh

Usingcurl:

curl -O https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/autoinstall.shsudo chmod +x autoinstall.shcurl -O https://raw.githubusercontent.com/EndstoneMC/endstone/main/scripts/start.shsudo chmod +x start.sh

Once the download is complete, run the following command to install Endstone:

./autoinstall.sh

This will install Endstone and automatically start the server after installation.

If you want to start Endstone at any time, simply run:

./start.sh

To try Endstone from the latest Docker image, use the following command:

docker pull endstone/endstonedocker run --rm -it -p 19132:19132/udp endstone/endstone

This will pull the latest Endstone image and run it interactively in your terminal.

For advanced users, you may build Endstone locally from the source.

First, clone the repository:

git clone https://github.com/EndstoneMC/endstone.git --recurse-submodulecd endstone

Then, you can build the wheel and install it on your local machine:

pip install.endstone

Please note that building from source requires toolchains to be installed on your system.

Currently, the Endstone project is under active development, and we invite you to review our roadmap. While you wait,why not take a sneaky peek of our example plugins which illustrate the friendliness of the plugin API. If you haveprevious experience with Bukkit, you should find the API particularly intuitive to work with:

• C++ Example Plugin
• Python Example Plugin

Here's a legend to guide you:

• ✅: Task is completed. Woohoo! 🎉
• 🚧: Task is under way. We're on it! 💪
• ⏳: Task is up next. Exciting things are coming! 🌠

We warmly welcome contributions to the Endstone project! If you're enthusiastic about enhancing Bedrock DedicatedServers with Python and C++ and have ideas on how to improve Endstone, here are a few ways you can contribute:

If you encounter any bugs while using Endstone, please open anissue inour GitHub repository. Ensure to include a detailed description of the bug and steps to reproduce it.

We appreciate code contributions. If you've fixed a bug or implemented a new feature, please submit a pull request!Please ensure your code follows our coding standards and include tests where possible.

The Endstone project is licensed under theApache-2.0 license.