Skip to content
Snippets Groups Projects
Commit f6599f9d authored by Jan Frieder Milke's avatar Jan Frieder Milke
Browse files

Updated uproject to 5.3 and Readme

parent 3ba070e9
Branches
No related tags found
No related merge requests found
......@@ -4,13 +4,42 @@ Unreal Engine project template catering to the common use cases at RWTH VR. Cont
## Getting Started
### Add the template
`git clone -b 5.1 --recurse-submodules https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unrealprojecttemplate.git` to your local `UnrealEngine/Templates` directory.
```bash
# go to your local Unreal Engines' templates directory
# (e.g. C:/Unreal/UE_5.3/Templates)
cd your/UnrealEngine/Templates
# clone with submodules
git clone -b 5.3 https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unrealprojecttemplate.git
```
### 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.
When creating a new Project using Unreal you can find the template under `New Project -> C++ -> RWTH-VR`.
Then you should:
1. Add necessary submodules (`rwth-vr-toolkit`, `dtrack`)
2. Change the remote to your personal repository
Therefore, after you created the project open the project folder in the terminal (git-bash on windows) execute the follwing:
```bash
# add rwth-vr-toolkit
git submodule add -b dev/5.3 https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit.git Plugins/rwth-vr-toolkit
# add dtrack plugin
git submodule add https://github.com/VRGroupRWTH/UnrealDTrackPlugin.git Plugins/UnrealDTrackPlugin
# add more plugins if you like
# if you need to remove a plugin:
# git submodule deinit Plugins/<Plugin>
# or
# git rm Plugins/<Plugin>
## Pitfalls
Downloading the project directly from GitHub/GitLab will not work since it will not include the necessary submodules. Clone recursively instead.
# rename origin remote to template origin
git remote rename origin template_origin
# add new remote pointing to your repository
git remote add origin https://git-ce.rwth-aachen.de/OWNER/REPOSITORY.git
git push -u origin --all
git push -u origin --tags
```
## FAQ
Visit the project's wiki under https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unrealprojecttemplate/-/wikis/home for more information.
Visit the [project's wiki](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/unrealprojecttemplate/-/wikis/home) for more information.
{
"FileVersion": 3,
"EngineAssociation": "5.1",
"EngineAssociation": "5.3",
"Category": "",
"Description": "",
"Modules": [
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment