README.md

March 21, 2025 ยท View on GitHub

Discord License Unity

UltimateXR

UltimateXR is an advanced open-source framework for VR development in Unity. Whether you're creating VR applications for training, simulations, or games, UltimateXR provides powerful and flexible tools to accelerate your development.

๐Ÿš€ Get Started Quickly: Installation Guide | API Reference | Join Discord

๐ŸŒŸ Why Choose UltimateXR?

โœ… Modular & Scalable โ€“ Designed for enterprise applications and games.
โœ… Cross-Platform VR โ€“ Works seamlessly with major VR SDKs and hardware.
โœ… Feature-Rich โ€“ Includes locomotion, interactions, hand tracking, haptics, and more.
โœ… Battle-Tested โ€“ Used in real-world VR games and applications.
โœ… Developer-Friendly โ€“ Clean, well-documented code with an intuitive API.
โœ… Open Source & Actively Maintained โ€“ Community-driven with ongoing support.
โœ… MIT License โ€“ Free to use, modify, and contribute.

โœจ Features

๐Ÿคฒ Precision Interaction โ€“ Advanced grab and manipulation mechanics.
๐Ÿ– Hand Pose Editor โ€“ Built-in tool for custom hand poses.
๐Ÿš€ Versatile Locomotion โ€“ Supports multiple movement mechanics.
๐ŸŽง Haptics & Feedback โ€“ Advanced feedback for immersive VR experiences.
๐Ÿฆพ Full-Body IK Avatars โ€“ Customizable avatars with inverse kinematics. (Legs IK coming soon!)
๐ŸŒ Networking-Ready โ€“ Multiplayer support. (Available in the stable v1.0.0 development branch)
๐Ÿข Enterprise-Grade Architecture โ€“ Built for serious VR applications.
๐Ÿ“– Well-Documented Code โ€“ Clean, structured, and fully documented.


๐Ÿ“ฅ Installation

Recommended Method: Install via Unity's Package Manager for Git users.

๐Ÿ“ฆ Method 1: Install via Git (Recommended)
  1. Remove any previous version of UltimateXR from /Assets/UltimateXR.
  2. Open Unity and go to Window > Package Manager.
  3. Click the + button and select "Add package from git URL...".
  4. Enter the following URL:
    https://github.com/VRMADA/ultimatexr-unity.git
    
  5. Click Add and wait for installation.
  6. If this is your first time using UltimateXR, import the example scenes.
๐Ÿ“ฆ Method 2: Install via .unitypackage
  1. Remove any existing UltimateXR folder from /Assets/UltimateXR.
  2. Download the latest .unitypackage from Releases.
  3. Double-click the .unitypackage file to import it into Unity.
๐Ÿ“ฆ Method 3: Install from Unity Asset Store
  1. Remove any existing UltimateXR folder from /Assets/UltimateXR.
  2. Visit the Unity Asset Store.
  3. Click "Open in Unity" to start the installation.

๐Ÿ“š Learn UltimateXR

๐Ÿ›  Installation & Setup

๐ŸŽฏ Supported Platforms

๐ŸŽฎ Main Components

๐Ÿ“œ API & Scripting


โค๏ธ Thanks to Our Contributors!

Contributors


๐ŸŒ Community & Support

Join our community to get help and collaborate with other developers!

  • ๐Ÿ’ฌ Discord โ€“ Chat with developers & contributors.
  • ๐Ÿฆ Twitter โ€“ Follow us for updates.
  • ๐Ÿ“– Documentation โ€“ Full guides & tutorials.

๐ŸŽฏ Try UltimateXR Today โ†’ Installation Guide