开始使用 Schola

安装先决条件

LinuxWindows

• Ubuntu 22.04。 (建议使用 22.04.4 Desktop x86 64 位以保证可复现性)

• Unreal Engine 5.5。 (建议使用 5.5.2 以保证可复现性)

• Python 3.9 至 3.12

说明

虽然也可以使用其他集成开发环境 (IDE)，但建议使用 Visual Studio Code 配合 C/C++ 扩展包。有关更多信息，请参阅 Unreal Engine 文档。

• Windows 11 或 Windows 10

• Unreal Engine 5.5。 (建议使用 5.5.2 以保证可复现性)

• Python 3.9 至 3.12

说明

虽然也可以使用其他集成开发环境 (IDE)，但建议使用 Visual Studio。 (建议使用 Visual Studio Professional 2022 (64 位) - LTSC 17.8 以保证可复现性)

请遵循 Epic Games 的 Visual Studio 设置指南 来设置您的 Visual Studio 环境以使用 Unreal。

安装 Schola

1. 将 Schola 作为 Unreal Engine 插件添加到项目中，可以通过下载源代码或通过 git 来完成。

Git 子模块独立 Git 存储库

git submodule add https://github.com/GPUOpen-LibrariesAndSDKs/Schola.git  ./Plugins/Schola

git clone https://github.com/GPUOpen-LibrariesAndSDKs/Schola.git ./Plugins

说明

如果您在通过 git 安装存储库时遇到由于文件过大而导致的错误，请运行以下命令以增加 git 缓冲区大小

git config –global http.postBuffer 524288000

2. 请确保在从 Plugins/Schola/Resources/python 安装 schola Python 包之前更新 pip。

   python -m pip install --upgrade pip
   pip install ./Plugins/Schola/Resources/python[all]

   说明

   Schola 默认安装 pytorch 的 CPU 版本，要安装其他版本的 pytorch，请按照 Pytorch Get Started 上的说明进行操作。

   说明

   要在 Linux 上安装带有 ROCm 的 Pytorch，我们建议遵循 为 Radeon GPU 安装 Pytorch 中的指南。

3. 使用您选择的编辑器，例如 Visual Studio 或 Visual Studio Code 来编译项目源文件。在项目编译完成之前，Schola 插件不会出现在编辑器中，也无法使用。

4. 像往常一样在 Unreal Engine 中启动您的项目。您应该会在项目设置的“插件”部分看到 Schola 插件。

为 Schola 构建第三方依赖项 (可选)

Schola 已内置所有 C++ 依赖项。但是，如果您想使用不同版本的依赖项或 Unreal Engine，可以从源代码进行构建。

从源代码构建 Schola 的 gRPC

1. 安装先决条件

LinuxWindows

• Ubuntu 22.04。 (建议使用 22.04.4 Desktop x86 64 位以保证可复现性)

• Unreal Engine 5.5。 (建议使用 5.5.2 以保证可复现性)

• Python 3.9 至 3.12

说明

虽然也可以使用其他集成开发环境 (IDE)，但建议使用 Visual Studio Code 配合 C/C++ 扩展包。有关更多信息，请参阅 Unreal Engine 文档。

• Git VCS

• Unreal Engine 5.5

• Visual Studio (2017，已安装 VC++ 工具 v141，或 Visual Studio 2022，需 VC++ 工具)

• CMake (用于从 gRPC 提供的 CMakeLists.txt 生成 Visual Studio 解决方案)

• Strawberry perl

• NASM

说明

某些安装步骤可能需要将上述先决条件添加到您的 PATH 中。

2. 通过从插件根目录运行以下命令，使用 /Resources/Build 中的脚本构建 gRPC

LinuxWindows

# Install Required Packages for Running the Build Script
sudo apt update
sudo apt-get -y install cmake git automake autoconf libtool-bin pkg-config build-essential

# Change this to your Unreal Engine path
UE_ROOT="~/UnrealEngine/UE_5.5"
export UE_ROOT
bash ./Resources/Build/linux_dependencies.sh

# Change this to your Unreal Engine path if it is different than the default.
set UE_ROOT="C:\Program Files\Epic Games\UE_5.5"
./Resources/Build/windows_dependencies.bat

重新生成 Protobuf 和 gRPC 代码

1. 请按照“从源代码构建 Schola”部分中的步骤，从源代码构建 gRPC，并获取最新版本的 protoc.exe。

2. 运行以下命令以重新生成 protobuf 和 gRPC 代码。

   python schola-build-proto --plugin-folder . --add-type-stubs

   说明

   —add-type-stubs 标志是可选的，它将为生成的代码生成 .pyi 文件。这对于支持类型存根以获得更好代码补全的 IDE 很有用。但是，并非所有 protobuf/gRPC 功能都支持 .pyi 文件。如果在生成时遇到问题，请尝试不带该标志运行。