Working-Title MSFS Mods 项目教程

1. 项目目录结构及介绍

Working-Title MSFS Mods 项目的目录结构如下：

fspackages/
├── github/
│   └── workflows/
├── vscode/
├── PackageDefinitions/
├── docs/
├── src/
├── working-title-msfs-mods/
│   └── github/
│       └── io/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── build.ps1
├── package.json
├── workingtitle-project-cj4.xml
├── workingtitle-project-cj4meta.xml
├── workingtitle-project-g1000.xml
├── workingtitle-project-g3000-noroaddata.xml
├── workingtitle-project-g3000.xml
└── workingtitle-project-gx.xml

目录介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• vscode/: 包含 Visual Studio Code 的配置文件。
• PackageDefinitions/: 包含项目的包定义文件。
• docs/: 包含项目的文档文件。
• src/: 包含项目的源代码文件。
• working-title-msfs-mods/github/io/: 包含项目的 GitHub Pages 相关文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitattributes: Git 属性配置文件，用于指定文件的属性。
• .gitignore: Git 忽略文件配置，用于指定不需要跟踪的文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。
• build.ps1: 项目的构建脚本。
• package.json: 项目的包管理配置文件。
• workingtitle-project-*.xml: 项目的配置文件，用于定义不同的模块和功能。

2. 项目的启动文件介绍

项目的启动文件主要是 build.ps1 脚本。该脚本用于构建和启动项目。以下是启动文件的简要介绍：

build.ps1

• 功能: 该脚本用于自动化项目的构建过程，包括编译代码、打包资源、生成配置文件等。
• 使用方法: 在 PowerShell 中运行 ./build.ps1 即可启动项目的构建过程。

3. 项目的配置文件介绍

项目的配置文件主要位于根目录下，以下是几个重要的配置文件介绍：

package.json

• 功能: 该文件用于管理项目的依赖和脚本。
• 内容: 包含项目的名称、版本、依赖库、脚本命令等信息。

workingtitle-project-*.xml

• 功能: 这些文件用于定义项目的不同模块和功能的配置。
• 内容: 包含模块的名称、版本、依赖项、配置参数等信息。

.editorconfig

• 功能: 该文件用于统一代码风格，确保不同开发者编写的代码风格一致。
• 内容: 包含缩进、换行、字符集等代码风格的配置。

.gitattributes

• 功能: 该文件用于指定 Git 仓库中文件的属性。
• 内容: 包含文件的编码、换行符等属性配置。

.gitignore

• 功能: 该文件用于指定不需要 Git 跟踪的文件和目录。
• 内容: 包含临时文件、编译输出、IDE 配置文件等不需要跟踪的内容。

通过以上配置文件，开发者可以方便地管理和配置项目，确保项目的稳定性和可维护性。