MachineLearningRemote-Unreal 插件使用教程

MachineLearningRemote-Unreal 插件使用教程

MachineLearningRemote-UnrealMachine Learning plugin for the Unreal Engine, encapsulating calls to remote python servers running e.g. Tensorflow/Pytorch.项目地址:https://gitcode.com/gh_mirrors/ma/MachineLearningRemote-Unreal

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

MachineLearningRemote-Unreal/
├── .gitignore
├── .gitmodules
├── LICENSE
├── MachineLearningRemote.uplugin
├── README.md
└── Source/
    ├── MachineLearningRemote
    │   ├── Private/
    │   │   ├── MachineLearningRemote.cpp
    │   │   ├── MachineLearningRemote.h
    │   │   └── ...
    │   └── Public/
    │       ├── MachineLearningRemoteBPLibrary.cpp
    │       ├── MachineLearningRemoteBPLibrary.h
    │       └── ...
    └── ...

• .gitignore: 用于指定Git版本控制系统忽略的文件和目录。
• .gitmodules: 用于定义子模块配置。
• LICENSE: 项目的许可证文件，本项目使用MIT许可证。
• MachineLearningRemote.uplugin: 虚幻引擎插件的描述文件。
• README.md: 项目说明文档。
• Source/: 插件的源代码目录。
  • MachineLearningRemote/: 插件的主要源代码目录。
    • Private/: 私有源代码文件，包括主要的实现文件。
    • Public/: 公共源代码文件，包括蓝图库的实现文件。

2. 项目的启动文件介绍

项目的启动文件主要是 MachineLearningRemote.uplugin，这是一个JSON格式的文件，用于描述插件的元数据和配置信息。以下是该文件的主要内容：

{
    "FileVersion": 3,
    "Version": 1,
    "VersionName": "1.0",
    "FriendlyName": "MachineLearningRemote",
    "Description": "A Machine Learning (ML) plugin for the Unreal Engine encapsulating calls to remote python servers running python ML libraries like Tensorflow or Pytorch",
    "Category": "Other",
    "CreatedBy": "getnamo",
    "CreatedByURL": "https://github.com/getnamo",
    "DocsURL": "",
    "MarketplaceURL": "",
    "SupportURL": "https://github.com/getnamo/MachineLearningRemote-Unreal/issues",
    "EnabledByDefault": false,
    "CanContainContent": false,
    "IsBetaVersion": false,
    "Installed": false,
    "Modules": [
        {
            "Name": "MachineLearningRemote",
            "Type": "Runtime",
            "LoadingPhase": "Default",
            "WhitelistPlatforms": [
                "Win64",
                "Mac",
                "Linux"
            ]
        }
    ]
}

• FileVersion: 插件文件格式的版本。
• Version: 插件的版本号。
• VersionName: 插件版本的名称。
• FriendlyName: 插件的友好名称。
• Description: 插件的描述信息。
• Category: 插件的分类。
• CreatedBy: 插件的创建者。
• CreatedByURL: 创建者的URL。
• SupportURL: 支持的URL，通常是GitHub的Issues页面。
• Modules: 插件包含的模块信息。

3. 项目的配置文件介绍

项目的配置文件主要是 MachineLearningRemote.uplugin，如上所述，它包含了插件的基本信息和模块配置。此外，项目中可能还包括其他配置文件，例如：

• Source/MachineLearningRemote/Private/MachineLearningRemote.cpp: 插件的主要实现文件，包含了插件的核心逻辑。
• Source/MachineLearningRemote/Public/MachineLearningRemoteBPLibrary.cpp: 蓝图库的实现文件，用于在虚幻引擎中通过蓝图调用插件功能。

这些文件通常包含了插件的具体实现细节和配置选项，开发者可以根据需要进行修改和扩展。

---

以上是 MachineLearningRemote-Unreal 插件的基本使用教程，希望对您有所帮助。

MachineLearningRemote-UnrealMachine Learning plugin for the Unreal Engine, encapsulating calls to remote python servers running e.g. Tensorflow/Pytorch.项目地址:https://gitcode.com/gh_mirrors/ma/MachineLearningRemote-Unreal