uesvon 项目使用教程
1. 项目的目录结构及介绍
uesvon 是一个用于 Unreal Engine 的 3D 导航网格生成和寻路插件。以下是项目的目录结构及其介绍:
uesvon/
├── Config/ # 配置文件目录
├── Content/ # 内容文件目录
├── Resources/ # 资源文件目录
├── Source/ # 源代码目录
├── .clang-format # 代码格式化配置文件
├── .gitignore # Git 忽略文件配置
├── LICENSE # 项目许可证
├── README.md # 项目说明文档
└── UESVON.uplugin # 插件配置文件
目录介绍
- Config: 包含插件的配置文件。
- Content: 包含插件的内容文件,如示例地图等。
- Resources: 包含插件所需的资源文件。
- Source: 包含插件的源代码。
- .clang-format: 用于代码格式化的配置文件。
- .gitignore: 用于指定 Git 版本控制系统忽略的文件和目录。
- LICENSE: 项目的许可证文件。
- README.md: 项目的说明文档。
- UESVON.uplugin: 插件的主要配置文件。
2. 项目的启动文件介绍
项目的启动文件是 UESVON.uplugin
,这是一个 JSON 格式的文件,用于定义插件的元数据和配置信息。以下是该文件的主要内容:
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.0",
"FriendlyName": "UESVON",
"Description": "3D navmesh generation and pathfinding plugin for UnrealEngine",
"Category": "Navigation",
"CreatedBy": "midgen",
"CreatedByURL": "",
"DocsURL": "",
"MarketplaceURL": "",
"SupportURL": "",
"CanContainContent": true,
"IsBetaVersion": false,
"Installed": false,
"Modules": [
{
"Name": "UESVON",
"Type": "Runtime",
"LoadingPhase": "Default",
"WhitelistPlatforms": []
},
{
"Name": "UESVONEditor",
"Type": "Editor",
"LoadingPhase": "Default",
"WhitelistPlatforms": []
}
]
}
主要字段介绍
- FileVersion: 文件版本号。
- Version: 插件版本号。
- VersionName: 版本名称。
- FriendlyName: 插件的友好名称。
- Description: 插件的描述信息。
- Category: 插件的分类。
- CreatedBy: 插件的创建者。
- Modules: 插件包含的模块信息,包括运行时模块和编辑器模块。
3. 项目的配置文件介绍
项目的配置文件位于 Config
目录下,主要包含插件的配置信息。以下是配置文件的主要内容:
[UESVON]
; 插件的主要配置信息
EnableNavMeshGeneration=true
EnableAsyncPathfinding=true
MaxSceneSize=10000
主要配置项介绍
- EnableNavMeshGeneration: 是否启用导航网格生成功能。
- EnableAsyncPathfinding: 是否启用异步寻路功能。
- MaxSceneSize: 支持的最大场景尺寸。
以上是 uesvon 项目的基本使用教程,包括项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该插件。