UnrealProjectTemplate
Unreal Engine project template catering to the common use cases at RWTH VR. Contains nDisplayExtensions, AixCAVE config files, launch scripts and more.
Getting Started
Add the template
git clone -b master --recurse-submodules https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/unrealprojecttemplate.git
to your local UnrealEngine/Templates
directory. If you are using Unreal version 4.21 you need to change the master
to deprecated/4-21
. If you know what you are doing and want the latest features use the develop
branch instead of the master
branches.
Create a new project
When creating a new Project using Unreal you can find the template under New Project -> C++ -> RWTH-VR
. After you created the project, open the project folder in the terminal (git-bash on windows) and run the setup.sh
. This will remove the git remote of the template and optionally lets you add a new remote. This will allow you to call update.sh
in the future to merge important changes made in the template back into your project. For more details about updating your project can be found in the wiki.
Pitfalls
Downloading the project directly from GitHub/GitLab will not work since it will not include the necessary submodules. Clone recursively instead.
FAQ
Visit the project's wiki under https://devhub.vr.rwth-aachen.de/VR-Group/unrealprojecttemplate/wikis/home for more information.