Skip to content

Scripts and prefabs to allow custom gesture detection via Mixed Reality Toolkit in Unity

License

Notifications You must be signed in to change notification settings

septianrazi/MRTK-Custom-Gestures-Unity

Repository files navigation

MIT License

MRTK Custom Gestures in Unity

Scripts and prefabs to allow custom gesture detection via Mixed Reality Toolkit (MRTK) in Unity

Table of Contents
  1. About The Project
  2. Getting Started
  3. Examples
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project

This repository allows you to use custom gestures to trigger events using Microsoft Mixed Reality Toolkit (MRTK). It utilises the inbuild MRTK implementation of Hand Tracking via IMixedRealityHandPose to detect positions of joints to a custom gesture. To see how you can use it in your own project, see here.

Inspired by Oculus Custom Hand Pose tutorial by Valem

Built With

Getting Started

Prerequisites

You will need to download and install the following:

Use in your own Projects

To use the custom hand gestures in your own projects, its as simple as using the GestureDetectorGlobal.cs script onto a gameObject in a scene in your project. Find out more including how to setup your own custom gestures here.

Running the Project

  1. Clone the repo
    git clone git@github.com:septianrazi/MRTK-Custom-Gestures-Unity.git
  2. Open Project in Unity (2020 above recommended)
  3. Change build setttings depending on intended hardware (Android for Oculus, Universal Windows Platform for Hololens)
  4. Edit the project and include your own custom gestures
  5. Build and Run the project on your device

Examples

Custom Gestures on the Hololens:

HoloLens Example

Custom Gestures on the Oculus:

Oculus Example

Both examples above use three different hand gestures on either the right or left hand that will cause a sphere object to spawn and track to the users hand. The gestures include: THUMBS UP, FINGER GUN, SPIDERMAN, AND TWO.

Naruto In Mixed Reality

Hand Gestures trigger the special moves in Naruto In Mixed Reality

Naruto In Mixed Reality RasenShuriken Example

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Choose an Issue you want to work on and assign yourself

    If there is no exsiting issue, please submit one

  2. Fork the Project

  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  4. Commit your Changes (git commit -m 'Add some AmazingFeature')

  5. Push to the Branch (git push origin feature/AmazingFeature)

  6. Open a Pull Request linking the issue

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Septian Razi - septianrazi.github.io - raziseptian@gmail.com

Project Link: https://github.com/septianrazi/MRTK-Custom-Gestures-Unity

Acknowledgements

About

Scripts and prefabs to allow custom gesture detection via Mixed Reality Toolkit in Unity

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published