BoundingBoxOutlineReloaded 项目教程

BoundingBoxOutlineReloaded 项目教程

BoundingBoxOutlineReloaded项目地址:https://gitcode.com/gh_mirrors/bo/BoundingBoxOutlineReloaded

1. 项目的目录结构及介绍

BoundingBoxOutlineReloaded 项目的目录结构如下：

BoundingBoxOutlineReloaded/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── bbor/
│   │   │       ├── client/
│   │   │       ├── common/
│   │   │       ├── config/
│   │   │       ├── events/
│   │   │       ├── network/
│   │   │       └── tags/
│   │   └── resources/
│   │       ├── assets/
│   │       │   └── bbor/
│   │       │       ├── lang/
│   │       │       └── textures/
│   │       ├── data/
│   │       │   └── bbor/
│   │       │       └── tags/
│   │       └── META-INF/
│   │           └── mods.toml
│   └── test/
│       └── java/
│           └── bbor/
├── gradle/
├── build.gradle
├── gradlew
├── gradlew.bat
├── settings.gradle
└── README.md

目录结构介绍

• src/main/java/bbor/: 包含项目的主要代码。
  • client/: 客户端相关的代码。
  • common/: 通用代码，适用于客户端和服务端。
  • config/: 配置文件相关的代码。
  • events/: 事件处理相关的代码。
  • network/: 网络通信相关的代码。
  • tags/: 标签相关的代码。
• src/main/resources/: 包含项目的资源文件。
  • assets/bbor/: 模组资源文件，如语言文件和纹理。
  • data/bbor/tags/: 数据标签文件。
  • META-INF/mods.toml: 模组描述文件。
• gradle/: Gradle 构建工具的配置文件。
• build.gradle: 项目的构建脚本。
• gradlew 和 gradlew.bat: Gradle 包装脚本。
• settings.gradle: Gradle 设置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/main/java/bbor/ 目录下，主要包括以下几个关键文件：

• BoundingBoxOutlineReloaded.java: 项目的主类，负责初始化和启动模组。
• client/ClientProxy.java: 客户端代理类，处理客户端特定的初始化任务。
• common/CommonProxy.java: 通用代理类，处理通用初始化任务。

启动文件介绍

• BoundingBoxOutlineReloaded.java:

  • 该文件是项目的主类，包含 preInit, init, 和 postInit 方法，用于在不同阶段初始化模组。
  • 通过 @Mod 注解指定模组的 ID 和其他属性。

• ClientProxy.java:

  • 继承自 CommonProxy，负责处理客户端特定的初始化任务，如注册渲染器和处理客户端事件。

• CommonProxy.java:

  • 包含通用的初始化方法，如注册网络消息和配置文件。

3. 项目的配置文件介绍

项目的配置文件位于 src/main/resources/META-INF/ 目录下，主要包括以下几个关键文件：

• mods.toml: 模组描述文件，包含模组的元数据和依赖信息。

配置文件介绍

• mods.toml:
  • 该文件描述了模组的基本信息，如模组 ID、版本、作者、依赖等。
  • 通过 TOML 格式配置，易于阅读和编辑。

示例 mods.toml 文件内容：

modLoader="javafml"
loaderVersion="[34,)"
license="MIT"
issueTrackerURL="https://github.com/irtimaled/BoundingBoxOutlineReloaded/issues"

[[mods]]
modId="bbor"
version="1.0.0"
displayName="Bounding Box Outline Reloaded"
updateJSONURL="https://github.com/irtimaled/BoundingBoxOutlineReloaded/update.json"

BoundingBoxOutlineReloaded项目地址:https://gitcode.com/gh_mirrors/bo/BoundingBoxOutlineReloaded