Table of Contents
- Project Creation: Our VR Template
- Branch Conventions
- Learning Unreal
- Improving Performance
- Coding Guidelines
- Unreal on the CAVE
Project Creation: Our VR Template
Our Unreal Template is a perfect starting point for your Unreal Project. Check out the template repository and the corresponding Wiki site.
Branch Conventions
We have a naming scheme for branches in place to ease development across Unreal versions (discussed in Software Meeting on 01.07.2021).
Please see the branch_system.pdf (slightly outdated as of 11.05.2023, see the addition of dev/major.minor below).
Basically, name your main branches after Unreal's Engine version (ignore the patch version) in the following fashion:
-
dev/major.minor(e.g.dev/5.1) for yet not working states -
major.minor(e.g.5.1) for working states
Features are outsourced to custom branches until they are merged into the main branches. They should be named feature/xyz, so for a feature foo create the branch feature/foo.
Learning Unreal
Because of its popularity there is a huge amount of internet tutorials. Be sure to check out the following resources: Unreal's Learning Library, the official Unreal Documentation and its Samples and Tutorials.
There are many more resources, just have a look at our Programming Resources.
Improving Performance
Unreal has a dedicated section in its official documentation regarding performance optimization. We also have the Wiki page Performance Debugging and Profiling dedicated to this topic.
Coding Guidelines
Please have a look at the official Unreal Coding Guidelines when writing Code. This is the standard we use ourselves.
Unreal on the CAVE
If you want to run Unreal on the Cave, you can find more information in the Unreal on the CAVE page.