UETorch项目安装与使用手册

UETorch项目安装与使用手册

UETorch 项目地址: https://gitcode.com/gh_mirrors/uet/UETorch

1. 项目目录结构及介绍

UETorch是一个专为Unreal Engine 4设计的插件，它集成Lua/Torch脚本能力到游戏引擎循环中，并提供一系列Lua API以支持用户输入、截屏、分割掩模处理、控制游戏状态等高级功能。以下是其基本的目录结构概述：

• 根目录

  • CODE_OF_CONDUCT.md: 项目的行为准则文件。
  • CONTRIBUTING.md: 对于贡献者来说的指导性文档，说明了如何参与项目贡献。
  • LICENSE: 许可证文件，表明项目采用了BSD-licensed许可证并附带专利许可。
  • PATENTS: 专利相关声明。
  • README.md: 主要的说明文件，涵盖了项目简介、要求、安装步骤和快速入门指南。
  • Setup.bat, Setup.sh: 分别用于Windows和Linux系统的设置脚本。
  • UETorch.uplugin: 插件定义文件，描述了插件的基本信息。
  • UnrealEngine.patch, UnrealEngine_Win.patch: 针对Unreal Engine特定版本的补丁文件。
  • uetorch_activate.bat, uetorch_activate.sh: 用来激活UETorch环境的脚本。

• Source/UETorch
  包含了插件的核心源代码和Lua相关的API实现。

• Scripts
  存放示例和核心脚本，如uetorch_example.lua演示了基础功能。

• 其他: 还可能包括一些辅助工具或配置文件，但根据提供的内容没有详细列出。

2. 项目的启动文件介绍

在Linux上

• Setup.sh 此脚本负责更新到Unreal Engine 4的特定版本，应用必要的补丁，以及设置Lua路径。运行此脚本是构建UETorch前的关键步骤。之后通过make命令编译整个工程。

在Windows上

• Setup.bat 类似于Linux上的Setup.sh，这个批处理文件执行相同的过程，但在Windows环境下操作。完成后，利用Visual Studio打开生成的.sln文件进行编译构建。

主执行文件

• 在成功构建Unreal Engine与UETorch插件后，实际上是由Unreal Editor（UE4Editor）作为主要的启动入口点。通过在相应的二进制目录下运行这个编辑器（Linux下的/UE4Editor，Windows下的\UE4Editor.exe），然后加载配置好的项目来启动。

3. 项目的配置文件介绍

UETorch的配置主要是通过以下几种方式体现：

• UETorch.uplugin文件
  插件的元数据文件，包含了插件名、版本号、所需UE4版本等关键信息，以及是否默认启用该插件等配置。

• Environment Configuration
  在实际使用过程中，配置主要通过脚本激活（uetorch_activate.sh/bat）时设定的环境变量（例如TORCH_LUA_VERSION）完成。这些脚本确保了正确的Lua版本被选用，并且设定所需的环境路径以便插件能够找到lua库和其他依赖。

• 内部脚本配置
  应用场景中的具体逻辑或配置通常嵌入到Lua脚本中，比如uetorch_example.lua可能会包含自定义行为的配置和参数设置。

请注意，虽然有特定的配置需求，UETorch并没有明确独立的配置文件，其配置过程更多是基于环境变量设置和脚本定制化的形式来实现。因此，在部署和使用UETorch时，重点在于正确执行上述脚本和设置正确的环境。

UETorch 项目地址: https://gitcode.com/gh_mirrors/uet/UETorch