Allay

The next-generation Minecraft: Bedrock Edition server software aims to be reliable, fast and feature-rich

📖 Introduction

Allay is a third-party server software for Minecraft: Bedrock Edition written from scratch, with the goal of being reliable, fast and feature-rich.

Important

Please note that this project is still at a very early stage and has not yet been released officially, and interfaces may be added or removed without notice. Please do not use Allay in a production environment!

🎯 Why Allay?

• Fast: Allay is a very fast. Compared to almost all other server software, Allay is far more performant in almost all aspects. The written from scratch codebase allows us to re-examine performance critical points and solve problems in the most efficient way.
• Reliable: Allay is designed to be reliable. To achieve this goal, we have written a lot of unit tests to ensure the stability of the project.
• Hassle-free: Allay is designed to be user-friendly and is ready to use right out of the box. We also have complete documentation to guide you in your deployment.
• Developer-friendly: Our api is seperated from the implementation and is well-documented. No more wasting time looking at the implementation.
• Feature-rich: One of our goal is to be feature-rich. Thanks to the architecture of Allay, adding new features is very easy for us.
• Cross-platform:: Benefit from JVM, allay can run on almost any platform.

🛠️ Getting Started

Allay is written and running in java 21, so you need to install java 21. There are several version of java, and we recommend you to use GraalVM for the best performance. OpenJDK is also a good choice if you want to have a stable experience.

After you have installed java 21, there are two ways to install Allay:

⚡ Use AllayLauncher

AllayLauncher is the launcher for allay. It has some cool features such as auto-updating, daemon mode and java checker. To use it, just run the following command based on your OS:

Linux:

wget -qO- https://raw.githubusercontent.com/AllayMC/AllayLauncher/refs/heads/main/scripts/install_linux.sh | bash

Windows (PowerShell):

Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/AllayMC/AllayLauncher/refs/heads/main/scripts/install_windows.ps1").Content

🔨 Install Allay Manually

If you platform does not support AllayLauncher, don't be worry! You can also install Allay manually. Just download the allay-server-*-shaded.jar file from our release page. Move it to the folder you want and run:

java -jar allay-server-*-shaded.jar

🌟 Plugins

Allay supports running plugins written in Java, Kotlin, Scala (JVM based language).

Use Plugin Template

The quickest way to create a new plugin is to use our plugin template! You can check out the following plugin templates:

• JavaPluginTemplate
• ScalaPluginTemplate
• KotlinPluginTemplate

Use Allay in Existing Project

If you have an existing project and want to use Allay in it, you can add the following dependencies to your project:

repositories {
    mavenCentral()
    maven("https://www.jitpack.io/")
    maven("https://repo.opencollab.dev/maven-releases/")
    maven("https://repo.opencollab.dev/maven-snapshots/")
    maven("https://storehouse.okaeri.eu/repository/maven-public/")
}

dependencies {
    compileOnly(group = "org.allaymc.allay", name = "api", version = "master-SNAPSHOT")
}

Currently, we use jitpack to publish our artifacts. If you want to use a specified version, you can check the version list in jitpack and replace master-SNAPSHOT with the version you want.

🙌 Contributing

Contributions are welcomed! And please read CONTRIBUTING.md before contributing. There are several ways you can contribute:

Submitting a Pull Request

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.

This project exists thanks to the participation of the following developers:

Feedback

Your feedback can make this project better. If you find a problem/have a new idea, feel free to raise it in the issues page. Ensure to include a detailed description of the bug and steps to reproduce it.

🎫 License

Copyright © 2023-2025 AllayMC, all rights reserved. If not otherwise specified, project content is open source under the LGPL-3.0 license. The contents of the following folders are open-sourced under the MIT license:

• data
• codegen

❤ Special Thanks

• Endstone: The devtools developed by them enable us to dump useful data from BDS
• Protocol: The protocol & raknet implementation used by Allay
• df-mc: The well-documented protocol lib provided by them is very useful for reference
• pmmp: The PocketMine-MP project provides a lot of useful information for us

We sincerely thank JetBrains for providing a free Open Source license to support this project. Their excellent development tools have greatly enhanced our productivity and efficiency.

YourKit has granted AllayMC team an open-source license to their outstanding Java profiler, allowing us to make our software as performant as it can be!

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of the YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

👀 Stargazers over time