Skip to content

Changes

Page history
Update HowToUse authored by Jonathan Ehret's avatar Jonathan Ehret
Show whitespace changes
Inline Side-by-side
HowToUse.md
View page @ 0e5f9fc1
......@@ -7,7 +7,7 @@
* Set game instance (``Settings -> Project Settings -> Maps&Modes``) to ``SFGameInstance``
* Set game mode (``Settings -> Project Settings -> Maps&Modes``) Set to ``SFGameMode``
* Potentially set the mouse to not be captured to use the UI (``Settings --> Project Settings --> Input --> Default Viewport Mouse Capture Mode = No Capture``), **should however not be necessary when using the latest ``RWTH VR Toolkit`` version.**
* To use packages builds, e.g., CAVE, tick ``Settings --> Project Settings -> Packaging --> Cook everything in the project content directory``
* To use packages builds, e.g., CAVE, tick ``Settings --> Project Settings -> Packaging --> Cook everything in the project content directory`` (more information in: [Packaging Section](Packaging)
## Setup Phases and Factors etc.
* This framework requires a Setup map (e.g., simply the Main level) which is started and contains a study setup, but is not part of the study itself. Add a SFStudySetup (``StudyFrameworkPlugin C++ Classes -> StudyFrameworkPlugin -> Public -> SFStudySetup``) actor to this level. In the properties section of this actor we can set up the study. Whenever a property of the StudySetup is changed, this change will automatically be saved to a JSON file, by default "StudySetup.json" located in the ```[ProjectDir]/StudyFramework``` folder. You can switch between different setup files, using the ```Select Setup File```-function. Note: Setup files have to be located on the same drive as the project folder.\
......