diff --git a/README.md b/README.md index 0b500df1d237855f82461fb2534645b743d6db20..4e251f76184c94d2ae63da64c76427b578a6bb16 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,45 @@ -# UnrealProjectTemplate +# Unreal Project Template 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 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.1/Templates) +cd your/UnrealEngine/Templates + +# clone with submodules +git clone -b 5.1 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.1 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.