|
|
**Table of Contents**
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
## Project Creation: Our VR Template
|
|
|
|
|
|
Our Unreal Template is a perfect starting point for your Unreal Project. Check out [the template repository](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unrealprojecttemplate/-/tree/5.3) and the corresponding [Wiki site](/Unreal/Getting-Started/Unreal-5-Template).
|
|
|
|
|
|
## 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](uploads/047534f1b3dab0184945aeb74dac49ab/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](https://docs.unrealengine.com/5.1/en-US/versioning-of-assets-and-packages-in-unreal-engine/) (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](https://dev.epicgames.com/community/unreal-engine/learning), the [official Unreal Documentation](https://docs.unrealengine.com/5.3) and its [Samples and Tutorials](https://docs.unrealengine.com/5.1/en-US/samples-and-tutorials-for-unreal-engine/).
|
|
|
|
|
|
There are many more resources, just have a look at [our Programming Resources](/Unreal/Programming-Resources Collection).
|
|
|
|
|
|
## Improving Performance
|
|
|
|
|
|
Unreal has a dedicated section in its [official documentation](https://docs.unrealengine.com/5.3/en-US/testing-and-optimizing-your-content/) regarding performance optimization. We also have the Wiki page [Performance Debugging and Profiling](Unreal/Performance-Debugging-and-Profiling) dedicated to this topic.
|
|
|
|
|
|
## Coding Guidelines
|
|
|
|
|
|
Please have a look at the [official Unreal Coding Guidelines](https://docs.unrealengine.com/5.3/en-US/epic-cplusplus-coding-standard-for-unreal-engine/) 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](Unreal/Unreal-on-the-CAVE) page. |
|
|
\ No newline at end of file |