Puerts 项目安装与使用教程
1. 项目目录结构及介绍
Puerts 项目的目录结构如下:
puerts/
├── doc/
│ ├── unreal/
│ └── unity/
├── unity/
│ ├── Assets/
│ │ ├── Puerts/
│ │ └── Scripts/
│ └── ProjectSettings/
├── unreal/
│ ├── Plugins/
│ │ └── Puerts/
│ └── Source/
├── LICENSE
├── README.md
└── ...
目录结构介绍
-
doc/: 包含 Puerts 的文档,分为 Unreal 和 Unity 两个子目录。
- unreal/: Unreal 引擎相关的文档。
- unity/: Unity 引擎相关的文档。
-
unity/: Unity 项目相关的文件。
- Assets/: Unity 项目的资源文件。
- Puerts/: Puerts 插件的资源文件。
- Scripts/: 用户自定义的 TypeScript 脚本文件。
- ProjectSettings/: Unity 项目的配置文件。
- Assets/: Unity 项目的资源文件。
-
unreal/: Unreal 项目相关的文件。
- Plugins/: Unreal 插件文件。
- Puerts/: Puerts 插件的源代码和资源文件。
- Source/: Unreal 项目的源代码文件。
- Plugins/: Unreal 插件文件。
-
LICENSE: 项目的开源许可证文件。
-
README.md: 项目的介绍和使用说明。
2. 项目的启动文件介绍
Unity 项目启动文件
在 Unity 项目中,Puerts 的启动文件通常位于 Assets/Puerts/
目录下。主要的启动文件包括:
- PuertsInitializer.cs: 这是 Puerts 在 Unity 中的初始化脚本,负责加载和初始化 TypeScript 运行时。
Unreal 项目启动文件
在 Unreal 项目中,Puerts 的启动文件通常位于 Plugins/Puerts/Source/
目录下。主要的启动文件包括:
- PuertsModule.cpp: 这是 Puerts 在 Unreal 中的模块初始化文件,负责加载和初始化 TypeScript 运行时。
3. 项目的配置文件介绍
Unity 项目配置文件
在 Unity 项目中,Puerts 的配置文件通常位于 ProjectSettings/
目录下。主要的配置文件包括:
- ProjectSettings.asset: 这是 Unity 项目的全局配置文件,Puerts 的相关配置也会在这里进行设置。
Unreal 项目配置文件
在 Unreal 项目中,Puerts 的配置文件通常位于 Plugins/Puerts/
目录下。主要的配置文件包括:
- Puerts.uplugin: 这是 Puerts 插件的配置文件,定义了插件的基本信息和依赖项。
通过以上步骤,您可以顺利安装和配置 Puerts 项目,并开始在 Unity 或 Unreal 引擎中使用 TypeScript 进行游戏开发。