|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
# General Usage
|
|
|
|
|
|
|
|
**For development guidelines, please read the [Development](Overview/Development) section carefully!**
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
To install the plugin into your existing Unreal Engine project, either simply clone the Plugin into your `Plugins` folder, or add it as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). This folder resides in your top-level Project directory. If you do not have it, just create it manually. More information on plugins can be found here in the [Unreal Docs](https://docs.unrealengine.com/5.0/en-US/working-with-plugins-in-unreal-engine/).
|
|
|
|
|
|
|
|
Make sure you have all respective plugins from the [Dependency](home#dependencies) section enabled for your use-case. This should normally happen automatically.
|
|
|
|
If you want to deploy to the cave, make sure you add the [DTrackPlugin](https://github.com/VRGroupRWTH/UnrealDTrackPlugin) (Make sure to use our fork!) by cloning/adding a submodule similar to the Toolkit.
|
|
|
|
|
|
|
|
That's it already!
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
The plugin comes with several [Unreal Gameplay Framework](https://docs.unrealengine.com/5.3/en-US/gameplay-framework-in-unreal-engine/) extensions (GameMode, PlayerState, Pawn, ...).
|
|
|
|
These extensions are explained in more detail in the [Content](#content) section below. However, their initial usage is very simple:
|
|
|
|
|
|
|
|
Set the default GameMode of your project to the VRGameMode, which automatically sets all the other required defaults. Alternatively, you can set the default GameMode in the World Settings. More info on setting GameModes can be found in the [Unreal docs](https://docs.unrealengine.com/5.3/en-US/game-mode-and-game-state-in-unreal-engine/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Additionally, if you want to deploy your project on the Cave, you currently need to drage the [`BP_CaveSetup` Actor](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit/-/blob/754c99290cc0ae8e511b1c1c718146ca2f57188a/Content/RWTHVRCluster/CaveSetup.uasset) into your scene (subject to change!).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For more information about how to deploy your project on the Cave, check the [Group Wiki's Unreal Index](https://git-ce.rwth-aachen.de/vr-vis/group-wiki/-/wikis/Unreal/Unreal-Index).
|
|
|
|
|
|
|
|
# Content
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
For regular Desktop usage, the following Unreal-internal dependencies are required:
|
|
|
|
|
|
|
|
- [nDisplay](https://docs.unrealengine.com/5.3/en-US/ndisplay-overview-for-unreal-engine/) (required for certain utility functions)
|
|
|
|
- [LiveLink](https://docs.unrealengine.com/5.3/en-US/live-link-in-unreal-engine/)
|
|
|
|
- [Enhanced Input](https://docs.unrealengine.com/5.3/en-US/enhanced-input-in-unreal-engine/)
|
|
|
|
- [Niagara](https://docs.unrealengine.com/5.3/en-US/creating-visual-effects-in-niagara-for-unreal-engine/)
|
|
|
|
|
|
|
|
For VR usage, the respective VR plugins are required:
|
|
|
|
|
|
|
|
- [OpenXR](https://docs.unrealengine.com/5.3/en-US/developing-for-head-mounted-experiences-with-openxr-in-unreal-engine/)
|
|
|
|
|
|
|
|
For Cluster/Cave usage, additionally to the basic requirements:
|
|
|
|
|
|
|
|
- [LiveLinkOvernDisplay](https://docs.unrealengine.com/5.3/en-US/API/Plugins/LiveLinkOverNDisplay/)
|
|
|
|
- [DTrackPlugin](https://github.com/VRGroupRWTH/UnrealDTrackPlugin) (Make sure to use our fork!)
|
|
|
|
- [Switchboard](https://docs.unrealengine.com/5.3/en-US/switchboard-in-unreal-engine/) (optional)
|
|
|
|
|
|
|
|
## Toolkit Module
|
|
|
|
|
|
|
|
The main toolkit module [`RWTHVRToolkit`](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit/-/tree/dev/5.3/Source/RWTHVRToolkit?ref_type=heads) contains the main functionality relevant to all platforms.
|
|
|
|
|
|
|
|
### GamePlay Framework
|
|
|
|
|
|
|
|
### Pawn
|
|
|
|
|
|
|
|
### Replication
|
|
|
|
|
|
|
|
### Utilities & Fixes
|
|
|
|
|
|
|
|
## Cluster Module
|
|
|
|
|
|
|
|
The cluster module [`RWTHVRCluster` ](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit/-/tree/dev/5.3/Source/RWTHVRCluster?ref_type=heads) extends the toolkits functionality by adding support for clustered rendering via [nDisplay](https://docs.unrealengine.com/5.3/en-US/ndisplay-overview-for-unreal-engine/).
|
|
|
|
|
|
|
|
### Configs & Setup
|
|
|
|
|
|
|
|
### Cave Overlay
|
|
|
|
|
|
|
|
### Cluster Console
|
|
|
|
|
|
|
|
### Cluster Events
|
|
|
|
|
|
|
|
## Editor Module
|
|
|
|
|
|
|
|
The editor module [`RWTHVRToolkitEditor`](https://git-ce.rwth-aachen.de/vr-vis/VR-Group/unreal-development/plugins/rwth-vr-toolkit/-/tree/dev/5.3/Source/RWTHVRToolkitEditor?ref_type=heads) in general contains features to enhace the editor experience, such as visualizers for certain components.
|
|
|
|
Currently, no such features are implemented.
|
|
|
|
|
|
|
|
# [Development](Overview/Development) |
|
|
\ No newline at end of file |
