ITADN · 发现全球开源项目

Allay

下一代 Minecraft: Bedrock Edition 服务器软件旨在可靠、快速且功能丰富

📖 简介

Allay 是一款为 Minecraft: Bedrock Edition 从零开始编写的第三方服务器软件，旨在可靠、快速且功能丰富。

🎯 为什么选择 Allay？

快速：Allay 非常快。与几乎所有其他服务器软件相比，Allay 在几乎所有方面都具有更高的性能。从零开始编写的代码库使我们能够重新审视性能关键点，并以最高效的方式解决问题。
可靠：Allay 旨在设计得可靠。为了实现这一目标，我们编写了大量单元测试以确保项目的稳定性。
无忧：Allay 旨在设计得用户友好，开箱即用。我们还有完整的文档来指导您进行部署。
开发者友好：我们的 api 与实现分离，并且文档完善。不再需要浪费时间查看实现细节。
功能丰富：我们的目标之一是功能丰富。得益于 Allay 的架构，为我们添加新功能非常容易。
跨平台：得益于 JVM，allay 几乎可以在任何平台上运行。
多版本：Allay 支持多版本。不再担心因版本更新而失去玩家。

🛠️ 快速开始

Allay 使用并运行在 java 21 上，因此您需要安装 java 21。java 有多个版本，我们建议您使用 GraalVM 以获得最佳性能。 OpenJDK 也是一个不错的选择，如果您希望获得稳定的体验。

安装 java 21 后，有两种方式安装 Allay：

⚡ 使用 AllayLauncher

AllayLauncher 是 allay 的启动器。它具有一些酷炫的功能，例如自动更新、守护进程模式和 java 检查器。要使用它，只需根据您的操作系统运行以下命令：

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

🔨 手动安装 Allay

如果你的平台不支持 AllayLauncher，请不要担心！你也可以手动安装 Allay。只需从我们的发布页面下载 allay-server-*-shaded.jar 文件。将其移动到你想要的文件夹并运行：

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

🌟 插件

Allay 支持运行使用 Java、Kotlin、Scala（基于 JVM 的语言）编写的插件。

使用插件模板

创建新插件的最快捷方式是使用我们的插件模板！您可以查看以下插件模板：

使用 Allay Gradle 插件

Allay 提供了一个 Gradle 插件，使开发 Allay 插件变得更加容易。请查阅 AllayGradle 以获取有关如何使用的更多信息。

在现有项目中使用 Allay

Allay API 已发布到 Maven Central。如果您有一个现有项目并希望在其中使用 Allay，只需将以下依赖项添加到您的项目中：

repositories {
    mavenCentral()
}

dependencies {
    compileOnly(group = "org.allaymc.allay", name = "api", version = "<version>")
}

您也可以使用正在开发中的快照版本。要获取快照版本，需要添加中央快照仓库：

repositories {
    mavenCentral()
    // Add the central snapshot repository
    maven("https://central.sonatype.com/repository/maven-snapshots/")
}

dependencies {
    // Add `-SNAPSHOT` suffix to the version to use the snapshot version, an example is `0.19.0-SNAPSHOT`
    compileOnly(group = "org.allaymc.allay", name = "api", version = "<version>-SNAPSHOT")
}

🙌 贡献

欢迎贡献！在贡献之前，请阅读 CONTRIBUTING.md。您可以通过以下几种方式做出贡献：

提交 Pull Request

我们感谢代码贡献。如果您修复了 bug 或实现了新功能，请提交一个 pull request！请确保您的代码符合我们的编码标准，并在可能的情况下包含测试。

本项目的存在得益于以下开发者的参与：

contributors

反馈

您的反馈可以让这个项目变得更好。如果您发现问题/有新想法，请随时在 issues 页面提出。请确保包含详细的 bug 描述和复现步骤。

🎫 许可证

data
codegen

❤️ 特别感谢

Endstone: Endstone 内置的 DevTools 对于 Allay 从 BDS 转储关键数据至关重要
Protocol: Allay 使用的 RakNet 协议库及实现
df-mc: 一些关键 API 设计的参考
gophertunnel: 文档完善的参考协议库
pmmp: 在许多方面提供了大量有用的信息

YourKit 已授予 AllayMC 团队其卓越 Java 分析器的开源许可证，使我们能够尽可能提升软件的性能！

YourKit 通过创新的智能工具支持开源项目，用于监控和分析 Java 和 .NET 应用程序。YourKit 是 YourKit Java Profiler、YourKit .NET Profiler 和 YourKit YouMonitor 的创造者。