https://github.com/crud89/unrealdr
Diminished Reality toolkit for Unreal Engine 4.
https://github.com/crud89/unrealdr
augmented-reality diminished-reality plug-in unreal-engine-4 virtual-reality visual-see-through vive-pro-eye
Last synced: about 2 months ago
JSON representation
Diminished Reality toolkit for Unreal Engine 4.
- Host: GitHub
- URL: https://github.com/crud89/unrealdr
- Owner: crud89
- License: mit
- Created: 2020-10-30T13:16:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-04T11:58:20.000Z (over 4 years ago)
- Last Synced: 2025-01-24T06:29:26.168Z (3 months ago)
- Topics: augmented-reality, diminished-reality, plug-in, unreal-engine-4, virtual-reality, visual-see-through, vive-pro-eye
- Language: C++
- Homepage:
- Size: 448 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UnrealDR
Diminished Reality toolkit for UE4.
## What is Diminished Reality?
Diminished Reality is a third category of virtual environments. Where Virtual Reality (VR) tries to simulate a whole environment and Augmented Reality tries to add to a real environment, Diminished Reality wants to alter real environments.
## Installation
First, download or clone the repository and move the contents into `MyProject/PlugIns/UnrealDR/`. Alternatively, you can add a [git submodule](https://git-scm.com/book/de/v2/Git-Tools-Submodule) to your project, to automatically restore the latest version on every checkout:
```ps
git submodule add https://github.com/Aschratt/UnrealDR.git Plugins/UnrealDR/
```
Next, open the `UnrealDR.uplugin` file and modify the `EngineVersion` property to fit your current version of Unreal Engine. When you open your project in Unreal Editor, the Plug-In should automatically activate and compile. If you are using a Visual Studio version, make sure to re-create the Solution afterwards.
## Prerequisites
The plug-in is designed to work with Virtual Reality HMDs that implement an OpenVR driver. Currently it is only tested on a HTC Vive Pro. UnrealDR does not use any dependencies that are not already included in Unreal Engine.
## Documentation
The documentation can be found in the [project wiki](https://github.com/Aschratt/UnrealDR/wiki).