Skip to content
Snippets Groups Projects

Changes

Page history
  • New page
  • Templates
    • Update home authored by Jonathan Ehret's avatar Jonathan Ehret
    Show whitespace changes
    Inline Side-by-side
    Showing
    with 7 additions and 8 deletions
    home.md
    View page @ a2a0252d
    ......@@ -2,12 +2,12 @@
    ## 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)**
    1. Check out the *master* or *development* branch of the template into ``UnrealEngine/[version]/Templates`` (for more info see [Unreal Doku](https://docs.unrealengine.com/en-us/Engine/Basics/Projects/CreatingTemplates)). The *develop* branch contains all the latest features whereas the *master* branch is stable and well tested.
    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)).
    **REMARK:** this step only needs to be done the first time you create an unreal project. However, you should always update it to the latest version before creating new project (`git pull`).
    2. Open the Unreal Editor and create a new project (you can find the template under `New Project -> C++ -> RWTH-VR`).
    2. Open the Unreal Editor and create a new project (you can find the template under `New Project Categories -> Games -> RWTH-VR`).
    3. Create a new empty repository here in the GitLab.
    4. Open the folder of the newly created project in the terminal (use git bash on windows)
    5. Run `./setup.sh` (**REMARK:** just double clicking the file under windows or choosing *Open With* and selecting *git-bash* currently does not work for some reason).
    4. Open the folder of the newly created project in the terminal
    5. Run `./setup.bat` under Windows (**REMARK:** you need to have python 3 and git installed and available in your PATH for that).
    When you want to upload the project to a new git repository, enter the url of the repository when you are asked, otherwise leave it blank. Make sure you use the url that appears by pressing the *clone* button in gitlab (either the ssh or https link) not the one in the url field of your browser.
    6. Optionally modify the `launcher.meta` file. More info can befound [here](https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/unreal-ci/-/wikis/How-to-use-the-launcher.meta-file)
    ......@@ -15,14 +15,13 @@
    The project template and the most commonly used plugins follow a naming scheme of branches where the branch name indicates the unreal version they are supposed to work with. This was discussed in the Software meeting on July 1st 2021. The following slides show the flow in the old an new systems: [branch_system.pdf](uploads/047534f1b3dab0184945aeb74dac49ab/branch_system.pdf).
    ## Adding non-default plugins:
    **In general this can be done by running the `./setup.bat` script again and choosing *Manage Plugins*,** but it can also be done manually, see below:
    * **NDisplay Launch Button:** Let's you launch, e.g., a mini-CAVE on your desktop that emulates cluster mode<br/>
    ``git submodule add -b master https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/NDisplayLaunchButton.git Plugins/NDisplayLaunchButton``
    * **Virtual Acoustics Plugin:** To use VA as developed by the Institute for technical Acoustics (ITA)<br/>
    ``git submodule add -b master https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/unreal-va-plugin.git Plugins/VAPlugin``
    * **Likert Scale Plugin:** To add Likert Scales to you application<br/>
    ``git submodule add -b master https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/likert-scale-plugin.git Plugins/LikertScalePlugin``
    * **Widget Interaction Plugin:** Currently used to interact with widgets like the Likert Scale<br/>
    ``git submodule add -b master https://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/widgetinteraction.git Plugins/WidgetInteraction``
    * **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://devhub.vr.rwth-aachen.de/VR-Group/unreal-development/universallogging.git Plugins/UniversalLogging``
    ......@@ -36,12 +35,12 @@ See the wiki page [Performance Debugging and Profiling](Performance-Debugging-an
    * What are the coding guidelines?
    > We use the default [Unreal coding guidelines](https://docs.unrealengine.com/en-US/Programming/Development/CodingStandard/index.html). See also this presentation: [ue4_coding_guideline.pptx](uploads/6c756e1762c6db24a23765ca8dab1e5f/ue4_coding_guideline.pptx)
    * What is the Display Cluster Settings Actor in the default map?
    > The Display Cluster Settings actor is used by nDisplay to store/read settings for the CAVE. It has to be in every map you create if you want your demo to work in the CAVE!
    > The Display Cluster Settings actor is used by nDisplay to store/read settings for the CAVE. It has to be in every map you create if you want your demo to work in the CAVE! (**only up to 4.22!**)
    * My demo is crashing at startup in the CAVE, what can it be?
    >>>
    This question is hard to answer, but here are a few suggestions:
    - Does the launcher.meta file inside your repo have the same structure? This could affect e.g. the selected config for your demo
    - Is the Display Cluster Settings Actor inside your level?
    - Is the Display Cluster Settings Actor inside your level? (**only required up to 4.22!**)
    - Are the submodules correctly checked into git?
    - Have you tried "cleaning" (killing old applications) the CAVE before launch?
    >>>
    ......