PKHeX-Plugins 项目教程

1. 项目目录结构及介绍

PKHeX-Plugins 项目的目录结构如下：

PKHeX-Plugins/
├── AutoLegalityMod/
├── AutoModTests/
├── PKHeX.Core.AutoMod/
├── PKHeX.Core.Enhancements/
├── PKHeX.Core.Injection/
├── .editorconfig
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Directory.Build.props
├── LICENSE
├── PKHeX-Plugins.sln
├── README.md
├── azure-pipelines.yml
├── setup_bleedingedge.ps1
└── setup_stable.ps1

目录介绍

• AutoLegalityMod/: 包含自动合法性修改插件的源代码。
• AutoModTests/: 包含自动合法性修改插件的测试代码。
• PKHeX.Core.AutoMod/: 包含 PKHeX 核心自动修改插件的源代码。
• PKHeX.Core.Enhancements/: 包含 PKHeX 核心增强功能的源代码。
• PKHeX.Core.Injection/: 包含 PKHeX 核心注入功能的源代码。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• Directory.Build.props: 项目构建属性配置文件。
• LICENSE: 项目许可证文件。
• PKHeX-Plugins.sln: 项目解决方案文件，用于 Visual Studio 打开项目。
• README.md: 项目介绍和使用说明文件。
• azure-pipelines.yml: Azure Pipelines 配置文件，用于持续集成。
• setup_bleedingedge.ps1: 用于设置最新版本的 PowerShell 脚本。
• setup_stable.ps1: 用于设置稳定版本的 PowerShell 脚本。

2. 项目的启动文件介绍

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

启动步骤

1. 打开 Visual Studio 2022。
2. 选择“打开项目或解决方案”。
3. 导航到 PKHeX-Plugins.sln 文件并打开。
4. 在解决方案资源管理器中，右键点击解决方案并选择“重建解决方案”。

3. 项目的配置文件介绍

PKHeX-Plugins 项目中有几个重要的配置文件，用于控制项目的构建和运行行为。

配置文件介绍

• .editorconfig: 这个文件定义了代码风格和格式化规则，确保所有开发者遵循一致的编码标准。
• .gitignore: 这个文件指定了 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本控制系统中。
• Directory.Build.props: 这个文件包含了项目构建的属性配置，如编译器选项、输出路径等。
• azure-pipelines.yml: 这个文件定义了 Azure Pipelines 的持续集成配置，包括构建、测试和部署步骤。
• setup_bleedingedge.ps1 和 setup_stable.ps1: 这两个 PowerShell 脚本用于设置项目的不同版本（最新版本和稳定版本），开发者可以根据需要选择使用。

配置文件的使用

• .editorconfig: 直接放置在项目根目录下，Visual Studio 会自动识别并应用其中的规则。
• .gitignore: 直接放置在项目根目录下，Git 会自动忽略文件中列出的文件和目录。
• Directory.Build.props: 放置在项目根目录下，Visual Studio 会在构建项目时自动读取其中的配置。
• azure-pipelines.yml: 放置在项目根目录下，用于配置 Azure Pipelines 的 CI/CD 流程。
• setup_bleedingedge.ps1 和 setup_stable.ps1: 开发者可以根据需要运行这些脚本，以设置项目的不同版本。

通过以上配置文件，开发者可以更好地管理和控制 PKHeX-Plugins 项目的构建和运行环境。