Vanquished Realm

Vanquished Realm is a virtual reality video game developed for a software engineering project at ENSSAT by the Team Kiwi. This game is made with the Godot engine v4.3 and is configured to run on the Meta Quest VR headsets (tested with the Meta Quest 2 and 3). The game uses Bastiaan Olij's OpenXR Vendors plugin where all basic VR features have been implemented in GDscript.

Bellow, you'll find an installation guide to try our game.
But if you're a programmer and want to dive deeper into the project, check out our wiki where we document every major feature to help you in your coding journey! 🚀

Thank you for playing our game on behalf of the whole team. If you want to contact us, feel free to join our official Discord server. Enjoy! 😉

📥 Installation Guide

To install the project and build the game on your VR headset, you need the game's .apk file. You can either:

1. 🛠 Build your own .apk from the project using Godot.
2. 📦 Use an existing .apk and deploy it directly on your headset with the Meta Quest Developer Hub.

---

📂 Contents

• Build your own .apk
  • Prerequisites
  • Set the SDK Paths
  • Create the Export Preset
  • Build on Your Headset
• Use an existing .apk

---

🛠 Build Your Own .apk

🔧 Prerequisites

Make sure you have the following installed:

• Godot Engine v4.3
• OpenJDK 17
• Android Studio
  • 🪟/🍎 Windows/macOS: Launch Android Studio once after installation.
  • 🐧 Linux: Run the following in a terminal:

    cd {installation_home}/bin
    ./studio.sh

🔗 Set the SDK Paths

After installing the prerequisites, configure the SDK paths in Godot's Editor settings:

Scroll down to the Android settings section:

Use the following paths based on your OS:

• 🪟 Windows:
  • Java SDK: C:/Program Files/Eclipse Adoptium/jdk-17.0.13.11-hotspot
  • Android SDK: C:/Users/{your_username}/AppData/Local/Android/Sdk
• 🐧 Linux:
  • Java SDK: /usr/lib/jvm/jdk-17.0.12-oracle-x64
  • Android SDK: ~/Android/Sdk
• 🍎 macOS:
  • Java SDK: /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
  • Android SDK: /Users/{your_username}/Library/Android/sdk

---

🎛 Create the Export Preset

To build the project as an .apk file, create an Android runnable export preset:

Then, enable Gradle build:

Select OpenXR as the XR Mode in the XR Features menu:

Enable the Meta Plugin:

---

🎮 Build on Your Headset

Once everything is set up, build the .apk and deploy it to your Meta Quest with remote debugging enabled:

🛠 Troubleshooting

If you are on Linux and encounter an error with adb, remove the previous version with:

adb uninstall {your_project}
# Example: adb uninstall com.example.metrovr

---

📦 Use an Already Existing .apk

If you already have an .apk file, use the Meta Quest Developer Hub app to deploy it to your headset:

That’s it! 🚀 Enjoy your game on VR! 🎮

---

Enjoy our game - Team Kiwi

Repository view counter

Free Website Counter