Skip to content

Latest commit

 

History

History
153 lines (99 loc) · 5.5 KB

README.md

File metadata and controls

153 lines (99 loc) · 5.5 KB
Raw

ProjectGhost

GhostBustXR is an asymmetrical multiplayer social XR game that creates friendly competition between one human and 3 ghosts. The trick is they are all controlled in real time by people either on their phones or on their headset. It’s fun spooky!

  • VR/ MR players are player avatars
  • AR players are ghost avatars
  • Spectator avatars

This project was part of the 2020 MIT Reality Hack XR: https://www.mitrealityhack.com/

Please visit our GhostBustXR DevPost page: https://devpost.com/software/ghosbustxr

Getting Started

Either directly clone, download, or fork your own copy of this repository. Be sure to reach out to the GhostBustXR development team and let us know how you intend on using this software.

Prerequisites

You will need the following environments for development:

Download Unity 2019.1.14f1 https://unity3d.com/get-unity/download/archive

Download Visual Studio 2019 https://visualstudio.microsoft.com/downloads/

XR Device Headsets Supports

HoloLens version 1, HoloLens version 2, Oculus Quest, HTC Vive, Valve Index, Windows Mixed Reality Devices, Android, iOS

Installing

Please download the above pre-requisites and respective XR device SDKs for your specific needs.

Running the tests

Report any issues or bugs for your test results within this project repo.

And coding style tests

Please see this guide for coding best practices: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

Deployment

Depending on your XR device endpoint you will need to follow the deployment guidelines set by the manufacture.

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Chris Papenfuss - Initial work - cefoot
  • Jason Evans - Initial work - jasevans
  • Sam De Lara - Initial work - samedelara
  • Frank O. - Initial work
  • Joshua Widdicombe - Initial work - joshbrookline

See also the list of contributors who participated in this project.

See also the GhostBustXR DevPot

License

  1. GhostBustXR is licensed under the Apache 2.0 License See the LICENSE. file for details

  2. Photon PUN Multiplayer Networking https://doc.photonengine.com/en-us/server/current/operations/licenses

  3. MRTK v2 Mixed Reality Toolkit for WMR and HoloLens v1 and HoloLens v2 MIT https://github.com/microsoft/MixedRealityToolkit-Unity/blob/mrtk_development/License.txt

  4. Azure Spatial Anchors Create mixed reality apps that map, designate, and recall precise points of interest that are accessible across HoloLens, iOS, and Android devices. Enable wayfinding across spaces to help your users collaborate more efficiently. MIT https://github.com/Azure/azure-spatial-anchors-samples/blob/master/LICENSE

  5. MRTK Extension for Oculus Quest This is Mixed Reality Toolkit (MRTK) extension for Oculus Quest. MIT https://github.com/HoloLabInc/MRTKExtensionForOculusQuest/blob/master/License.txt

  6. MRTK Extension for NReal Light Mixed Reality Toolkit (MRTK) extension for NReal Light. MIT https://github.com/HoloLabInc/MRTKExtensionForNrealLight/blob/master/LICENSE

  7. Blender 3D Creation Software https://www.blender.org/about/license/

  8. Substance Painter 3D Texturing Software https://www.substance3d.com/download/

  9. Free Music Archive Ambient Music https://freemusicarchive.org

  10. Sound Bible Click Sound, Intro Wind Attribution license http://soundbible.com/1705-Click2.html

  11. PNG Key Veins https://www.pngkey.com/download/u2e6r5t4w7o0t4i1_png-veins/

  12. Unity Asset Store Low Poly 3D Environment Free https://assetstore.unity.com/packages/3d/environments/dungeons/ultimate-low-poly-dungeon-143535

  13. Free Sound.Org Wailing Souls, Jingle Win Synth Attribution license https://freesound.org/people/Porphyr/sounds/189702/

  14. Orange Free Sounds Confused Sound Effect Attribution license http://www.orangefreesounds.com/confused-sound-effect/

Acknowledgments

  • Inspiration
  1. Mario Party / Mario Kart
  • Mario Party & Mario Kart encourage healthy competition among friends. The games are known for bringing people together and allowing people to get to know each other in a completely non-realistic and non-threatening environment.
  1. Beat Saber
  • This game was more of a negative influence on our game. It is because of games like Beat Saber, where inherently one person is immersed playing a game while others look on an spectate for hours, we wanted to create a game exactly the opposite of that- a game where everyone is immersed and able to play a game together.
  1. Pac Man
  • We borrowed the concept of the many ghosts vs one other player dynamic from this game.
  1. Ghostbusters
  • This title was a large part of our game’s namesake.
  1. Jackbox.tv Drawful 2
  • Jackbox.tv Drawful 2 multi-user party app demo
  1. Acron: Attack of the Squirrels!
  • Available for Oculus Quest, Rift, HTC Vive & Mobile