BTD-Mod-Helper 项目使用文档

1. 项目目录结构及介绍

BTD-Mod-Helper 项目的目录结构如下：

BTD-Mod-Helper/
├── BloonsTD6 Mod Helper/
│   ├── Documentation/
│   ├── Unity Assets/
│   ├── Website/
│   ├── Wiki/
│   ├── .editorconfig
│   ├── .gitattributes
│   ├── .gitignore
│   ├── BTD Mod Helper.sln
│   ├── LICENSE
│   ├── README.md
│   ├── banner.png
│   ├── global.json
│   ├── modders.json
│   ├── modoptions.bundle
│   └── problematic_patches.md
└── ...

目录结构介绍

• BloonsTD6 Mod Helper/: 项目的主目录，包含了所有与 BTD-Mod-Helper 相关的文件和子目录。
  • Documentation/: 存放项目的文档文件，包括使用指南、API 文档等。
  • Unity Assets/: 存放与 Unity 相关的资源文件，如模型、纹理、声音等。
  • Website/: 存放项目网站的源代码和相关文件。
  • Wiki/: 存放项目的 Wiki 页面，通常包含详细的教程和常见问题解答。
  • .editorconfig: 配置文件，用于统一代码风格和格式。
  • .gitattributes: Git 属性配置文件，用于指定文件的属性。
  • .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
  • BTD Mod Helper.sln: Visual Studio 解决方案文件，用于管理和构建项目。
  • LICENSE: 项目的开源许可证文件。
  • README.md: 项目的自述文件，通常包含项目的简介、安装指南和使用说明。
  • banner.png: 项目的横幅图片。
  • global.json: 项目的全局配置文件，通常用于指定 SDK 版本等。
  • modders.json: 存放与模组开发者相关的配置信息。
  • modoptions.bundle: 模组选项的资源包文件。
  • problematic_patches.md: 记录项目中可能存在问题的补丁或修改。

2. 项目的启动文件介绍

BTD-Mod-Helper 项目的启动文件主要是 BTD Mod Helper.sln，这是一个 Visual Studio 解决方案文件。通过打开这个文件，开发者可以在 Visual Studio 中加载整个项目，并进行编译、调试和运行。

启动文件介绍

• BTD Mod Helper.sln: 这是项目的解决方案文件，双击该文件可以在 Visual Studio 中打开整个项目。解决方案文件包含了项目的所有项目文件和配置信息，是开发者在 Visual Studio 中管理和构建项目的主要入口。

3. 项目的配置文件介绍

BTD-Mod-Helper 项目中有多个配置文件，用于不同的配置需求。以下是几个主要的配置文件及其作用：

配置文件介绍

• .editorconfig: 这个文件用于配置代码编辑器的风格和格式，确保所有开发者遵循一致的代码风格。例如，可以指定缩进大小、换行符类型等。

• .gitattributes: 这个文件用于指定 Git 管理文件的属性，例如指定某些文件使用特定的换行符类型，或者指定某些文件不需要进行合并操作。

• .gitignore: 这个文件用于指定哪些文件或目录不需要被 Git 管理。例如，临时文件、编译输出文件等可以被忽略。

• global.json: 这个文件通常用于指定项目的全局配置，例如指定使用的 .NET SDK 版本。

• modders.json: 这个文件用于存放与模组开发者相关的配置信息，例如开发者列表、权限设置等。

• modoptions.bundle: 这个文件是一个资源包，包含了模组选项的相关配置和资源文件。

通过这些配置文件，开发者可以灵活地管理和配置项目，确保项目的开发和维护更加高效和规范。