首页
/ Apollo 项目技术文档

Apollo 项目技术文档

2024-12-20 15:07:08作者:余洋婵Anita

1. 安装指南

1.1 环境准备

在开始安装 Apollo 之前,请确保您的系统已经安装了以下工具:

  • Java Development Kit (JDK):Apollo 是基于 Java 开发的,因此需要 JDK 来编译和运行项目。
  • Gradle:Apollo 使用 Gradle 作为构建工具,因此需要安装 Gradle。

1.2 下载项目

首先,从 GitHub 仓库下载 Apollo 项目的源代码:

git clone https://github.com/your-repo/Apollo.git
cd Apollo

1.3 构建项目

在项目根目录下运行以下命令来下载依赖并构建项目:

gradle build

1.4 配置数据文件

  1. 将目标客户端版本的完整缓存文件放置在 data/fs/[revision] 目录下。默认情况下,Apollo 兼容 377 版本,因此缓存文件应放置在 data/fs/377 目录中。
  2. data/ 目录下放置一个包含 RSA 私钥的 rsa.pem 文件。Apollo 提供了一个生成器 org.apollo.util.tools.RsaKeyGenerator,可以生成并写入该文件。如果使用生成器,您需要替换客户端中使用的公钥和模数(工具会打印新值)。
  3. 如果目标客户端版本不同,运行 EquipmentUpdater(位于 org.apollo.cache.tools),该工具会识别穿戴装备所需的战斗技能等级。如果版本包含 377 中未找到的装备,您可能需要手动更新该工具。

1.5 启动项目

完成上述步骤后,您可以通过以下命令启动 Apollo:

gradle run

2. 项目使用说明

2.1 默认配置

  • 玩家数据存储:默认情况下,玩家数据不会保存,所有登录的用户都将拥有管理员权限。您可以在 login.xml 文件中更改玩家序列化器以保存玩家数据。
  • 客户端版本:默认支持 377 版本,如果使用其他版本,请确保缓存文件和相关工具已正确配置。

2.2 自定义配置

  • RSA 密钥:如果需要自定义 RSA 密钥,可以使用 RsaKeyGenerator 工具生成新的密钥对,并替换客户端中的公钥和模数。
  • 装备更新:如果目标客户端版本包含新的装备,您需要手动更新 EquipmentUpdater 工具以确保装备穿戴要求的正确性。

3. 项目 API 使用文档

3.1 核心 API

  • org.apollo.util.tools.RsaKeyGenerator:用于生成 RSA 密钥对的工具。
  • org.apollo.cache.tools.EquipmentUpdater:用于更新装备穿戴要求的工具。

3.2 插件开发

Apollo 支持模块化插件开发。您可以通过编写自定义插件来扩展 Apollo 的功能。插件开发指南请参考 CONTRIBUTING.md

4. 项目安装方式

4.1 源码安装

  1. 克隆项目源码:
    git clone https://github.com/your-repo/Apollo.git
    
  2. 进入项目目录:
    cd Apollo
    
  3. 构建项目:
    gradle build
    
  4. 配置数据文件并启动项目。

4.2 二进制安装

如果您不想从源码构建,可以从项目的发布页面下载预编译的二进制文件。下载后解压并按照配置指南进行配置。


通过以上步骤,您应该能够成功安装并使用 Apollo 项目。如果在使用过程中遇到问题,请参考项目的 Discord 或创建 GitHub 问题。

登录后查看全文
热门项目推荐