🕹️ BunkerDefense

Basic shooter for SteamVR - Destroy the Wheelers with your gun before they blow up your bunker!

⚡ Deployment

These instructions will get a release of this project up and running on your local machine, so that you can start using it.

📋 Prerequisites

• Windows
  • 64-bit or 32-bit version
• SteamVR - The ultimate tool for experiencing VR content on the hardware of your choice
  • you also need a compatible headset

🚀 Getting Started

1. download the latest release
   • 32-bit: BunkerDefense-win_x86-<version>.zip
   • 64-bit: BunkerDefense-win_x86_64-<version>.zip
2. unzip the archive
3. run BunkerDefense.exe

🕹️ How to Play

1. look around and find the menu
2. read the instructions and controls
3. press Start on the menu

🐞 Troubleshooting

The pointer on the left controller doesn't work / is stuck to the ground

Restarting the game should fix this. Next time, make sure the controllers are turned on before starting the game.

The VR headset doesn't show the game, even though the game window is open and running on the monitor

In this situation at the top right corner of the game window above the button Switch SDK Setup it should say VRSimulator. This means SteamVR couldn't be initialized and the game had to fall back to the VR Simulator, which is only useful for development purposes. Make sure SteamVR is set up properly and then restart the game.

The Switch SDK Setup Menu doesn't always react to clicks

Due to a limitation of VRTK, the menu doesn't work properly when time is frozen, i.e. while the main menu is open. To switch between the VR Simulator and SteamVR, you will need to connect or disconnect the VR headset and then restart the game. If SteamVR is ready upon starting the game, the game will choose SteamVR, otherwise it will fall back to the VR Simulator.

Neither the character nor the controllers can be moved, only looking around works

In this situation at the top right corner of the game window above the button Switch SDK Setup it should say VRSimulator. This means you are using the VR Simulator, which is only useful for development purposes. Instead of using the VR Simulator with mouse and keyboard, you need to start SteamVR and connect a compatible headset and then restart the game.

🛠️ Development

These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.

📋 Prerequisites

• Unity - Real-time development platform
• SteamVR - The ultimate tool for experiencing VR content on the hardware of your choice
  • you also need a compatible headset

🚀 Getting Started

1. clone this repo
   • to skip steps 2 and 3, use git clone --recurse-submodules
2. open repo root folder in terminal
3. download all submodules using git submodule update --init --recursive
4. open repo root folder with Unity
5. open scene Assets/Scenes/Main

📘 Relevant Documentation

• VRTK 3.3.0
  • git repo
  • docs
    • Instructions for using the VR Simulator
      • ⚠️ the simulator doesn't support movement of body or controllers while time is frozen, i.e. while the main menu is open; also, the menu for the SDK Setup Switcher doesn't work while time is frozen
  • tutorial videos

🧰 Built With

📚 Resources

• How to Git with Unity
  • .gitattributes taken from the VRTK git repo
• VR in Unity: A Beginner's Guide (using VRTK)
  • we use VRTK 3.3.0 instead

🏛️ Libraries

• VRTK 3.3.0 - A productive VR Toolkit for rapidly building VR solutions in Unity3d
• UnityTimer - Powerful and convenient library for running actions after a delay in Unity3D

👨‍💻 Authors

• Wladimir Fedorow - Models and Explosion - Bljadt
• Robin Hartmann - Organization, Repository Setup and Programming - robin-hartmann
• Roby Jeitz - Models and Menu - RobyJeitz
• Ali Karimi - Research of VR essentials - alibk95

📃 License

This project is licensed under the MIT License - see the LICENSE file for details.

👍 Acknowledgments

• Special thanks to Wladimir, Roby and Ali for letting me publish this project