ProjectCleaner 项目教程

ProjectCleaner 项目教程

ProjectCleanerUnreal engine plugin for managing all unused assets and empty folders in project.项目地址:https://gitcode.com/gh_mirrors/pr/ProjectCleaner

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

ProjectCleaner/
├── Config/
│   └── Config Resources/
├── Source/
│   └── Pjc/
├── .gitignore
├── LICENSE
├── ProjectCleaner.uplugin
└── README.md

目录结构介绍

• Config/: 包含项目的配置资源文件。
• Source/Pjc/: 项目的源代码目录，包含主要的代码文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• LICENSE: 项目的开源许可证文件。
• ProjectCleaner.uplugin: 项目的插件配置文件，定义了插件的基本信息和依赖关系。
• README.md: 项目的说明文件，通常包含项目的简介、安装和使用说明。

2. 项目的启动文件介绍

项目的主要启动文件是 ProjectCleaner.uplugin。这个文件是一个 JSON 格式的配置文件，定义了插件的基本信息、依赖关系、模块和启动方式。

ProjectCleaner.uplugin 文件内容示例

{
    "FileVersion": 3,
    "Version": "1.0",
    "VersionName": "1.0",
    "FriendlyName": "ProjectCleaner",
    "Description": "Unreal engine plugin for managing unused assets and empty folders in your project.",
    "Category": "Plugins",
    "CreatedBy": "ashe23",
    "CreatedByURL": "https://github.com/ashe23",
    "DocsURL": "",
    "MarketplaceURL": "",
    "SupportURL": "",
    "EnabledByDefault": true,
    "CanContainContent": true,
    "IsBetaVersion": false,
    "Installed": false,
    "Modules": [
        {
            "Name": "ProjectCleaner",
            "Type": "Runtime",
            "LoadingPhase": "Default"
        }
    ]
}

启动文件介绍

• FileVersion: 插件文件的版本号。
• Version: 插件的版本号。
• VersionName: 插件版本的友好名称。
• FriendlyName: 插件的友好名称。
• Description: 插件的描述信息。
• Category: 插件的分类。
• CreatedBy: 插件的创建者。
• CreatedByURL: 创建者的 URL。
• Modules: 插件包含的模块信息，定义了模块的名称、类型和加载阶段。

3. 项目的配置文件介绍

项目的配置文件主要位于 Config/ 目录下，通常包含项目的配置资源文件。具体的配置文件内容和用途需要根据项目的实际需求进行定义。

配置文件示例

; Config/ConfigResources/DefaultConfig.ini

[ProjectCleaner]
EnableDetection = true
EnableCorruptedAssets = true
EnableIndirectAssets = true
EnableExternalFiles = true
EnableEmptyFolders = true

配置文件介绍

• EnableDetection: 是否启用未使用资产的检测。
• EnableCorruptedAssets: 是否启用损坏资产的检测。
• EnableIndirectAssets: 是否启用间接资产的检测。
• EnableExternalFiles: 是否启用外部文件的检测。
• EnableEmptyFolders: 是否启用空文件夹的检测。

这些配置项可以根据项目的实际需求进行调整，以满足不同的使用场景。

ProjectCleanerUnreal engine plugin for managing all unused assets and empty folders in project.项目地址:https://gitcode.com/gh_mirrors/pr/ProjectCleaner