Skip to content

m-ahmad-butt/Virtual-Reality

Repository files navigation

VR Stumble Guy - A Virtual Reality Game

An immersive Virtual Reality adaptation of the popular Stumble Guys game, built for Meta Quest 3

Screenshots

Home Screen 1

Home Screen 2

Gameplay 1

Gameplay 2

Game Over

Game Over

Overview

VR Stumble Guy is a fully immersive virtual reality experience that brings the chaotic fun of obstacle course racing to Meta Quest 3. Navigate through challenging courses, avoid obstacles, and compete to be the last player standing—all in stunning VR. This project leverages the powerful VRIF (VR Interaction Framework) by BNG to deliver smooth, intuitive VR interactions and locomotion mechanics optimized for the Meta Quest 3 platform.

Features

Core Gameplay

  • Immersive VR Obstacle Courses - Navigate through dynamic, challenging environments
  • Physics-Based Interactions - Realistic collision and ragdoll physics
  • Competitive Gameplay - Race against time and obstacles to reach the finish line
  • Multiple Game Modes - Various obstacle courses and challenges

VR-Specific Features

  • Hand Tracking Support - Native Meta Quest 3 hand tracking integration
  • Smooth Locomotion - Multiple movement options including teleportation and smooth movement
  • Intuitive Controls - Natural VR interactions using VRIF framework
  • Optimized Performance - Smooth 72Hz/90Hz rendering for comfortable VR experience
  • Room-Scale VR - Full 6DOF (Six Degrees of Freedom) movement

Technical Specifications

Component Details
Engine Unity 2022.3.59f1 LTS
VR Framework VRIF (VR Interaction Framework) - BNG Framework
Target Platform Meta Quest 3
Render Pipeline Universal Render Pipeline (URP)
Scripting Backend IL2CPP
API Compatibility Level .NET Standard 2.1
Minimum Android API Level 29 (Android 10)
Target Architecture ARM64

Prerequisites

Software Requirements

  • Unity Hub (Latest version)
  • Unity 2022.3.59f1 LTS (Exact version recommended)
  • Android Build Support module for Unity
  • Meta Quest Developer Hub (for deployment and debugging)
  • Git (for version control)

Installation

1. Clone the Repository

git clone https://github.com/m-ahmad-butt/Virtual-Reality.git
cd "Virtual-Reality"

2. Open in Unity

  1. Launch Unity Hub
  2. Click "Open" or "Add"
  3. Navigate to the cloned project folder: Stumble Guy-MetaQuest 3
  4. Ensure Unity 2022.3.59f1 is installed
  5. Unity will import all assets (this may take several minutes)

3. Configure Build Settings

  1. Go to File → Build Settings
  2. Select Android platform
  3. Click "Switch Platform" if not already selected
  4. Under Texture Compression, select ASTC
  5. Click "Player Settings" and configure:
    • Company Name: Your company/developer name
    • Product Name: VR Stumble Guy
    • XR Plug-in Management: Enable Oculus (Meta Quest)

4. Enable Developer Mode on Quest 3

  1. Install the Meta Quest Developer Hub or Meta Quest Mobile App
  2. Enable Developer Mode on your Quest 3
  3. Connect Quest 3 to PC via USB-C cable
  4. Allow USB debugging when prompted on headset

5. Build and Deploy

Option A: Build and Run (Recommended)

  1. In Unity, go to File → Build Settings
  2. Ensure your Quest 3 is connected and recognized
  3. Click "Build and Run"
  4. Choose a location to save the APK
  5. Unity will build and automatically install on your Quest 3

Option B: Build APK Only

  1. Click "Build" instead of "Build and Run"
  2. Save the APK file
  3. Use SideQuest or Meta Quest Developer Hub to install manually

Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development Guidelines

  • Follow Unity C# coding conventions
  • Test all changes on actual Meta Quest 3 hardware
  • Document new features and changes
  • Ensure backward compatibility when possible

License

This project is for educational purposes.

Releases

No releases published

Packages

 
 
 

Contributors