Getting Started with Schola
Install Prerequisites
-
Ubuntu 22.04 (22.04.4 Desktop x86 64-bit is recommended for reproducibility)
-
Unreal Engine 5.4 (5.4.4 is recommended for reproducibility)
-
Python 3.9 (3.9.19 is recommended for reproducibility)
Note
While other Integrated Development Environments (IDEs) can be used, Visual Studio Code is recommended along with the C/C++ Extension Pack. Please see the Unreal Engine documentation for more information.
-
Unreal Engine 5.4 (5.4.4 is recommended for reproducibility)
-
Python 3.9 (3.9.19 is recommended for reproducibility)
Note
While other Integrated Development Environments (IDEs) can be used, Visual Studio is recommended. (Visual Studio Professional 2022 (64-bit) – LTSC 17.8 is recommended for reproducibility)
Follow the Visual Studio setup guide from Epic Games to setup your Visual Studio environment for working with Unreal.
Install Schola
-
Add Schola to a project as an Unreal Engine Plugin, either by downloading the source, or via git.
-
Create a folder named
Scholain thePluginsfolder of your Unreal Engine project. -
Download the zipped source code from the Schola Repository
-
Unzip the repository. Copy the contents of the
Scholafolder to theScholafolder you created in your project.
Copied!
git submodule add https://github.com/GPUOpen-LibrariesAndSDKs/Schola.git ./Plugins/ScholaCopied!
git clone https://github.com/GPUOpen-LibrariesAndSDKs/Schola.git ./PluginsNote
If you experience an error installing the repository with git due to a large file sizes, run the following command to increase the git buffer size:
Copied!
git config –global http.postBuffer 524288000 -
-
Install the schola python package from /Resources/python.
Copied!
pip install ./Plugins/Schola/Resources/python[all] -
Launch your project as normal in Unreal Engine. You should see the Schola plugin in the Plugins section of the project settings.
Building Schola from source (Optional)
Schola comes bundled with all of its c++ dependencies already. However, if you want to use a different version of a dependency, or unreal engine you may build them from source.
Building gRPC from source for Schola
-
Install Prerequisites
-
Ubuntu 22.04 (22.04.4 Desktop x86 64-bit is recommended for reproducibility)
-
Unreal Engine (5.4.4 is recommended for reproducibility)
-
Python 3.9 (3.9.19 is recommended for reproducibility)
Note
While other Integrated Development Environments (IDEs) can be used, Visual Studio Code is recommended along with the C/C++ Extension Pack. Please see the Unreal Engine documentation for more information.
-
Unreal Engine (5.4.4 is recommended for reproducibility)
-
Visual Studio (2017 with VC++ tools v141 installed, or Visual Studio 2022 with VC++ tools)
-
CMake (used to generate a Visual Studio solution from the
CMakeLists.txtprovided with gRPC)
Note
Some install steps may require adding the above prerequisites to your PATH.
-
-
Build gRPC using the scripts in /Resources/Build, by running the following from the Plugin Root Dir
Copied!
# 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.4" export UE_ROOT bash ./Resources/Build/linux_dependencies.shNote
You may need to manually update libtool-bin as old versions of libtool-bin` may cause errors during install.
Copied!
# Change this to your Unreal Engine path if it is different than the default. set UE_ROOT="C:\\Program Files\\Epic Games\\UE_5.4" ./Resources/Build/windows_dependencies.bat
Regenerated Protobuf and gRPC Code
-
Follow the steps in the Building Schola from source section to build gRPC from source, and get an up to date version of protoc.exe.
-
Run the following command to regenerate the protobuf and gRPC code.
Copied!
python schola-build-proto --plugin-folder . --add-type-stubsNote
The –add-type-stubs flag is optional and will generate .pyi files for the generated code. This is useful for IDEs that support type stubs for better code completion. However, not all protobuf/gRPC features are supported in the .pyi files. If you encounter issues when generating try running without the flag.
