EasySynth 开源项目使用教程

EasySynth 开源项目使用教程

EasySynthUnreal Engine plugin for easy creation of synthetic image datasets项目地址:https://gitcode.com/gh_mirrors/ea/EasySynth

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

EasySynth 是一个用于 Unreal Engine 的插件，旨在简化合成图像数据集的创建。以下是该项目的目录结构及其介绍：

EasySynth/
├── Content/
│   ├── Blueprints/
│   ├── Materials/
│   ├── Meshes/
│   ├── Textures/
├── Plugins/
│   ├── EasySynth/
│   │   ├── Binaries/
│   │   ├── Config/
│   │   ├── Resources/
│   │   ├── Source/
│   │   ├── EasySynth.uplugin
├── Config/
│   ├── DefaultEngine.ini
│   ├── DefaultEditor.ini
├── Source/
│   ├── EasySynth/
│   │   ├── Private/
│   │   ├── Public/
│   │   ├── EasySynth.Build.cs
│   │   ├── EasySynth.Target.cs

• Content/: 包含项目的内容文件，如蓝图、材质、网格和纹理。
• Plugins/: 包含 EasySynth 插件的文件。
  • EasySynth/: EasySynth 插件的主要目录。
    • Binaries/: 包含编译后的二进制文件。
    • Config/: 包含插件的配置文件。
    • Resources/: 包含插件所需的资源文件。
    • Source/: 包含插件的源代码。
    • EasySynth.uplugin: 插件的描述文件。
• Config/: 包含项目的配置文件，如 DefaultEngine.ini 和 DefaultEditor.ini。
• Source/: 包含项目的源代码。
  • EasySynth/: EasySynth 插件的源代码目录。
    • Private/: 包含私有源代码文件。
    • Public/: 包含公共源代码文件。
    • EasySynth.Build.cs: 构建配置文件。
    • EasySynth.Target.cs: 目标配置文件。

2. 项目的启动文件介绍

EasySynth 插件的启动文件是 EasySynth.uplugin，位于 Plugins/EasySynth/ 目录下。该文件是一个 JSON 格式的文件，包含了插件的基本信息和配置。

{
    "FileVersion": 3,
    "Version": 1,
    "VersionName": "1.0",
    "FriendlyName": "EasySynth",
    "Description": "Unreal Engine plugin for easy creation of synthetic image datasets",
    "Category": "Plugins",
    "CreatedBy": "ydrive",
    "CreatedByURL": "https://github.com/ydrive",
    "DocsURL": "",
    "MarketplaceURL": "",
    "SupportURL": "",
    "EnabledByDefault": true,
    "CanContainContent": true,
    "IsBetaVersion": false,
    "Installed": false,
    "Modules": [
        {
            "Name": "EasySynth",
            "Type": "Runtime",
            "LoadingPhase": "Default",
            "WhitelistPlatforms": []
        }
    ]
}

• FileVersion: 文件版本。
• Version: 插件版本。
• VersionName: 版本名称。
• FriendlyName: 插件的友好名称。
• Description: 插件的描述。
• Category: 插件的分类。
• CreatedBy: 插件的创建者。
• CreatedByURL: 创建者的 URL。
• DocsURL: 文档的 URL。
• MarketplaceURL: 市场的 URL。
• SupportURL: 支持的 URL。
• EnabledByDefault: 是否默认启用。
• CanContainContent: 是否可以包含内容。
• IsBetaVersion: 是否为测试版本。
• Installed: 是否已安装。
• Modules: 插件的模块信息。

3. 项目的配置文件介绍

EasySynth 插件的配置文件位于 Plugins/EasySynth/Config/ 目录下。主要的配置文件是 DefaultEngine.ini 和 DefaultEditor.ini。

DefaultEngine.ini

该文件包含了引擎的默认配置，如渲染设置

EasySynthUnreal Engine plugin for easy creation of synthetic image datasets项目地址:https://gitcode.com/gh_mirrors/ea/EasySynth