|
# Using the Template
|
|
# Using the Template
|
|
|
|
|
|
## Create a project based on the template:
|
|
## Create a project based on the template:
|
|
|
|
|
|
**This guide is for our latest support Unreal Engine version (check branch names for versions)! If you are using the (deprecated) version 4.21, look [here](Getting-Started/Unreal-4.21)**
|
|
**This guide is for our latest support Unreal Engine version (check branch names for versions)! If you are using the (deprecated) version 4.21, look [here](Getting-Started/Unreal-4.21)**
|
|
|
|
|
|
1. Check out the *appropriate* branch of the template (e.g., 4.26 for Unreal 4.26) into ``UnrealEngine/[version]/Templates`` (for more info see [Unreal Doku](https://docs.unrealengine.com/en-us/Engine/Basics/Projects/CreatingTemplates)).
|
|
1. Check out the *appropriate* branch of the template (e.g., 4.26 for Unreal 4.26) into ``UnrealEngine/[version]/Templates`` (for more info see [Unreal Doku](https://docs.unrealengine.com/en-us/Engine/Basics/Projects/CreatingTemplates)).
|
... | @@ -28,6 +30,22 @@ |
... | @@ -28,6 +30,22 @@ |
|
* **Universal Logging Plugin:** Used to log into your own files and also have logging in shipping builds available<br/>
|
|
* **Universal Logging Plugin:** Used to log into your own files and also have logging in shipping builds available<br/>
|
|
``git submodule add -b master https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/universallogging Plugins/UniversalLogging``
|
|
``git submodule add -b master https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/universallogging Plugins/UniversalLogging``
|
|
|
|
|
|
|
|
## Running your Demo
|
|
|
|
### Running/Deploying your application in the AixCAVE:
|
|
|
|
- Use the CI-Pipeline to build for CAVE. Deployment runs automatically. [More Information](https://devhub.vr.rwth-aachen.de/VR-Group/gitlab-ci-unreal-files/wikis/Setting-up-the-Pipeline-for-your-Project).
|
|
|
|
- To run your application use the launcher, which is the starting page of firefox on the cave master or the icon on the desktop
|
|
|
|
|
|
|
|
### Running your application in the ROLV:
|
|
|
|
- Follow https://docs.unrealengine.com/en-US/Engine/Rendering/Rendering-to-Multiple-Displays-with-nDisplay .
|
|
|
|
- Run `C:/UnrealLauncher/Utility/launch_rolv.bat` to launch DTrack, VRPN and nDisplayListener.
|
|
|
|
- Switch both the projector mode and nDisplayLauncher projection mode to "frame sequential" or "side-by-side".
|
|
|
|
|
|
|
|
### Running your application on a windows computer:
|
|
|
|
- Fetch your windows build from `/home/vrdev/UnrealCIDeploy/[PROJECT_NAME]/[PROJECT_BRANCH]/[PIPELINE_NUMBER]`
|
|
|
|
- Copy it to your computer/customers computer
|
|
|
|
- Optional: Run the `UE4PrereqSetup_x64.exe` in the `WindowsNoEditor/Engine/Extras/Redist/en-us` to install the prerequisites
|
|
|
|
- Run the `[PROJECT_NAME].exe` file. For VR mode, launch it via a commandline with the parameter '-vr'
|
|
|
|
|
|
# Developing for the Template
|
|
# Developing for the Template
|
|
|
|
|
|
The Template doesn't really **do** anything, so developing for it is very simple. It only contains a few required configurations.
|
|
The Template doesn't really **do** anything, so developing for it is very simple. It only contains a few required configurations.
|
... | @@ -53,19 +71,3 @@ The project template and the most commonly used plugins follow a naming scheme o |
... | @@ -53,19 +71,3 @@ The project template and the most commonly used plugins follow a naming scheme o |
|
* Can I use ``FMath::RandRange``
|
|
* Can I use ``FMath::RandRange``
|
|
> This will not work correctly in the CAVE, since all nodes run their own instances with potentially different execution orders and different seeds.
|
|
> This will not work correctly in the CAVE, since all nodes run their own instances with potentially different execution orders and different seeds.
|
|
> Use ``FRandomStream`` instead which you constantly seed in your constructor, e.g., ``RandomStream = FRandomStream(0);`` |
|
> Use ``FRandomStream`` instead which you constantly seed in your constructor, e.g., ``RandomStream = FRandomStream(0);`` |
|
|
|
|
|
# Running your Demo
|
|
|
|
### Running/Deploying your application in the AixCAVE:
|
|
|
|
- Use the CI-Pipeline to build for CAVE. Deployment runs automatically. [More Information](https://devhub.vr.rwth-aachen.de/VR-Group/gitlab-ci-unreal-files/wikis/Setting-up-the-Pipeline-for-your-Project).
|
|
|
|
- To run your application use the launcher, which is the starting page of firefox on the cave master or the icon on the desktop
|
|
|
|
|
|
|
|
### Running your application in the ROLV:
|
|
|
|
- Follow https://docs.unrealengine.com/en-US/Engine/Rendering/Rendering-to-Multiple-Displays-with-nDisplay .
|
|
|
|
- Run `C:/UnrealLauncher/Utility/launch_rolv.bat` to launch DTrack, VRPN and nDisplayListener.
|
|
|
|
- Switch both the projector mode and nDisplayLauncher projection mode to "frame sequential" or "side-by-side".
|
|
|
|
|
|
|
|
### Running your application on a windows computer:
|
|
|
|
- Fetch your windows build from `/home/vrdev/UnrealCIDeploy/[PROJECT_NAME]/[PROJECT_BRANCH]/[PIPELINE_NUMBER]`
|
|
|
|
- Copy it to your computer/customers computer
|
|
|
|
- Optional: Run the `UE4PrereqSetup_x64.exe` in the `WindowsNoEditor/Engine/Extras/Redist/en-us` to install the prerequisites
|
|
|
|
- Run the `[PROJECT_NAME].exe` file. For VR mode, launch it via a commandline with the parameter '-vr' |
|
|
|
\ No newline at end of file |
|
|