Skip to content
Snippets Groups Projects
Commit 73aad712 authored by David Gilbert's avatar David Gilbert :bug:
Browse files

docs: Update README.md

parent c2d9ab98
No related branches found
No related tags found
No related merge requests found
......@@ -16,54 +16,8 @@ Contains:
## Getting Started
For a more detailed description, see the [Getting Started Wiki](https://git-ce.rwth-aachen.de/vr-vis/unreal-wiki/-/wikis/Unreal/Getting-Started/Unreal-5-Template)
**For a more detailed description, see the [Getting Started Wiki](https://git-ce.rwth-aachen.de/vr-vis/unreal-wiki/-/wikis/Unreal/Getting-Started/Unreal-5-Template)**
### Add the template
```bash
# go to your local Unreal Engines' templates directory
# (e.g. C:/Unreal/UE_5.3/Templates)
cd your/UnrealEngine/Templates
# clone
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`.
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 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:
```bash
# git submodule deinit Plugins/<Plugin>
# or
# git rm Plugins/<Plugin>
```
To change the remote to your personal repository:
```bash
# 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
```
| Warning :warning: _16.04.2024_ |
| ------------------------------ |
| The default map in the unrealprojecttemplate won't work out of the box for the CAVE. You need to add a BP_CaveSetup to the map!
## FAQ
Visit the [group wiki](https://git-ce.rwth-aachen.de/vr-vis/group-wiki/-/wikis/Unreal/Unreal-Index) for more information.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment