Allay 项目使用教程

Allay 项目使用教程

Allay The next-generation Minecraft: Bedrock Edition server software 项目地址: https://gitcode.com/gh_mirrors/al/Allay

1. 项目目录结构及介绍

Allay 项目的目录结构如下：

Allay/
├── api/
├── codegen/
├── data/
├── docs/
├── gradle/
├── server/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── build.gradle.kts
├── codecov.yml
├── gradle.properties
├── gradlew
├── gradlew.bat
├── jitpack.yml
├── mkdocs.yml
├── settings.gradle.kts

目录介绍

• api/: 包含项目的API接口代码。
• codegen/: 代码生成相关的文件。
• data/: 项目的数据文件。
• docs/: 项目的文档文件。
• gradle/: Gradle构建工具的配置文件。
• server/: 服务器核心代码。
• .gitignore: Git忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• build.gradle.kts: Gradle构建脚本。
• codecov.yml: Codecov配置文件。
• gradle.properties: Gradle属性配置文件。
• gradlew: Gradle包装器脚本。
• gradlew.bat: Gradle包装器脚本（Windows批处理文件）。
• jitpack.yml: JitPack配置文件。
• mkdocs.yml: MkDocs配置文件。
• settings.gradle.kts: Gradle设置脚本。

2. 项目启动文件介绍

Allay 项目的启动文件位于 server/ 目录下。主要的启动文件是 server/src/main/java/org/allaymc/server/AllayServer.java。

启动文件介绍

• AllayServer.java: 这是 Allay 服务器的主启动类。它包含了服务器的初始化、配置加载和启动逻辑。

启动步骤

1. 确保你已经安装了 JDK 21 或更高版本。
2. 克隆 Allay 项目到本地：

   git clone https://github.com/AllayMC/Allay.git
   

3. 进入项目目录：

   cd Allay
   

4. 使用 Gradle 启动服务器：

   ./gradlew server:runShadow
   

3. 项目配置文件介绍

Allay 项目的配置文件主要位于 server/ 目录下。主要的配置文件是 server/src/main/resources/config.yml。

配置文件介绍

• config.yml: 这是 Allay 服务器的主要配置文件。它包含了服务器的各种配置选项，如端口、日志级别、插件路径等。

配置示例

server:
  port: 19132
  maxPlayers: 100
  motd: "Welcome to Allay Server"
  logLevel: INFO
plugins:
  path: "plugins/"

配置项说明

• port: 服务器监听的端口号。
• maxPlayers: 服务器允许的最大玩家数量。
• motd: 服务器欢迎消息。
• logLevel: 日志级别，可选值为 DEBUG, INFO, WARN, ERROR。
• plugins: 插件路径，指定插件存放的目录。

通过以上配置，你可以根据需要调整 Allay 服务器的运行参数。

Allay The next-generation Minecraft: Bedrock Edition server software 项目地址: https://gitcode.com/gh_mirrors/al/Allay