TTToolbox 项目使用教程
1. 项目的目录结构及介绍
TTToolbox 项目的目录结构如下:
TTToolbox/
├── Source/
│ └── TTToolbox/
│ ├── gitattributes
│ ├── gitignore
│ ├── LICENSE
│ ├── README.md
│ ├── TTToolbox.uplugin
│ ├── package_TTToolbox_UE5.3.0.cmd
│ ├── package_TTToolbox_UE5.4.0.cmd
├── github/
│ └── ISSUE_TEMPLATE/
│ ├── Config
│ ├── Content
│ ├── Resources
├── LICENSE
├── README.md
目录介绍:
Source/TTToolbox/
: 包含项目的主要源代码文件。gitattributes
: Git 属性配置文件。gitignore
: Git 忽略配置文件。LICENSE
: 项目许可证文件。README.md
: 项目说明文档。TTToolbox.uplugin
: Unreal Engine 插件配置文件。package_TTToolbox_UE5.3.0.cmd
: 打包脚本。package_TTToolbox_UE5.4.0.cmd
: 打包脚本。
github/ISSUE_TEMPLATE/
: 包含 GitHub 问题模板配置文件。Config
: 配置文件。Content
: 内容文件。Resources
: 资源文件。
LICENSE
: 项目许可证文件。README.md
: 项目说明文档。
2. 项目的启动文件介绍
项目的启动文件主要是 TTToolbox.uplugin
,这是一个 Unreal Engine 插件配置文件。它定义了插件的基本信息、依赖关系和模块结构。
TTToolbox.uplugin
文件内容示例:
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.0",
"FriendlyName": "TTToolbox",
"Description": "TTToolbox provides useful helper scripts to automate your character integration workflows in Unreal Engine",
"Category": "Plugins",
"CreatedBy": "tuatec",
"CreatedByURL": "https://github.com/tuatec",
"DocsURL": "",
"MarketplaceURL": "",
"SupportURL": "",
"EnabledByDefault": false,
"CanContainContent": false,
"IsBetaVersion": false,
"Installed": false,
"Modules": [
{
"Name": "TTToolbox",
"Type": "Runtime",
"LoadingPhase": "Default",
"WhitelistPlatforms": [
"Win64",
"Mac"
]
}
]
}
3. 项目的配置文件介绍
项目的配置文件主要是 gitattributes
和 gitignore
。
gitattributes
文件内容示例:
* text=auto
*.md text eol=lf
*.json text eol=lf
gitignore
文件内容示例:
# Unreal Engine
Binaries/
Intermediate/
Saved/
DerivedDataCache/
这些配置文件帮助管理项目的版本控制和文件格式。