Allay Allay - 下一代的MCBE服务端软件 0.3.0

[MD]
## 介绍

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

> 请注意，本项目仍处于非常早期的阶段，尚未正式发布，接口可能会添加或删除，恕不另行通知。请不要在生产环境中使用 Allay！

## 为什么选择 Allay？
- **快速**：Allay 非常快。与几乎所有其他服务器软件相比，Allay 在几乎所有方面都表现得更高效。从零编写的代码库让我们能重新审视性能关键点，并以最高效的方式解决问题。
- **可靠**：Allay 设计时注重可靠性。为此，我们编写了大量单元测试以确保项目稳定性。
- **易用**：Allay 设计友好，开箱即用。我们还提供完整的文档指导部署流程。
- **开发者友好**：我们的 API 与实现分离且文档齐全，无需再浪费时间阅读实现代码。
- **功能丰富**：我们的目标之一是功能丰富。得益于 Allay 的架构，添加新功能对我们来说非常容易。
- **跨平台**：基于 JVM（Java 虚拟机），Allay 可运行在几乎所有平台上。

## 快速开始

Allay 使用 Java 21 编写并运行，因此您需要安装 Java 21。我们推荐使用以下 Java 发行版：
- **[GraalVM](https://www.graalvm.org/)**：提供最佳性能。
- **[OpenJDK](https://adoptopenjdk.net/)**：稳定可靠的选择。

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

### 使用 AllayLauncher

[AllayLauncher](https://github.com/AllayMC/AllayLauncher) 是 Allay 的专用启动器，支持自动更新、守护进程模式和 Java 版本检查等功能。

Linux 安装命令：

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

Windows（PowerShell）安装命令：

```powershell
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/AllayMC/AllayLauncher/refs/heads/main/scripts/install_windows.ps1").Content
```
### 手动安装 Allay

如果您的平台不支持 AllayLauncher，也可手动安装。只需从[发布页面](https://github.com/AllayMC/Allay/releases)下载 `allay-server-*-shaded.jar` 文件，放入目标文件夹后运行：

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

## 插件开发

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

### 使用插件模板

快速创建插件的最佳方式是使用我们的模板项目：
- [Java 插件模板](https://github.com/AllayMC/JavaPluginTemplate)
- [Scala 插件模板](https://github.com/AllayMC/ScalaPluginTemplate)
- [Kotlin 插件模板](https://github.com/MineBuilders/allaymc-kotlin-plugin-template)

### 在现有项目中集成

若需在现有项目中集成 Allay，请添加以下依赖配置（以 Kotlin DSL 为例）：
```kts
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")
}
```

当前我们通过 [JitPack](https://jitpack.io/#AllayMC/Allay) 发布构件。如需使用特定版本，请替换 `master-SNAPSHOT` 为对应版本号。

## 参与贡献

欢迎贡献！请先阅读[贡献指南](CONTRIBUTING.md)。贡献方式包括：

### 提交 Pull Request

我们欢迎代码贡献。如果您修复了问题或实现了新功能，请提交 PR！请确保代码符合规范并包含必要的测试。

感谢以下开发者的贡献：

### 反馈问题

您的反馈能让项目更好。如发现问题或有新想法，请在 [Issues 页面](https://github.com/AllayMC/Allay/issues) 提交。请提供详细的问题描述和复现步骤。

## 许可证

版权所有 **© 2023-2025 AllayMC**，保留所有权利。除非特别说明，项目内容采用 [LGPL-3.0 许可证](https://www.gnu.org/licenses/lgpl-3.0.html) 开源。以下目录内容采用 MIT 许可证：
- `data`
- `codegen`

## 特别鸣谢

- **[Endstone](https://github.com/EndstoneMC/Endstone)**：其开发工具帮助我们从 BDS 中提取了关键数据
- **[Protocol](https://github.com/CloudburstMC/Protocol)**：Allay 使用的协议与 RakNet 实现
- **[df-mc](https://github.com/df-mc)**：其详尽的协议库为开发提供了重要参考
- **[pmmp](https://github.com/pmmp/PocketMine-MP)**：PocketMine-MP 项目提供了大量有用信息


衷心感谢 JetBrains 为本项目提供免费开源许可证。其卓越的开发工具极大提升了我们的生产力。

[](https://www.yourkit.com/)

感谢 YourKit 为本团队提供其优秀的 Java 性能分析工具的开源许可证，帮助我们优化性能！

YourKit 为开源项目提供创新的 Java 和 .NET 应用性能监控与分析工具，详情请访问：
- [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)
- [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/)
- [YourKit YouMonitor](https://www.yourkit.com/youmonitor/)

## 项目星标趋势

[](https://starchart.cc/AllayMC/Allay)

[/MD]