94 lines
3.6 KiB
Markdown
94 lines
3.6 KiB
Markdown
# VRP Team 6: Paradox_VR
|
||
|
||
Willkommen beim Projekt von **Team 6**!
|
||
|
||
> **Versions-Hinweis:** Dieses Projket wurde mit Godot 4.5.1 erstellt benutzen neuerer versionen auf eigene Gefahr
|
||
|
||
**Status:** 🚧 Work in Progress (WIP) – Weitere Inhalte folgen in Kürze.
|
||
|
||
---
|
||
## 🎨 Verwendete Assets
|
||
|
||
In diesem Projekt nutzen wir die großartigen Assets von **[Kenney.nl](https://kenney.nl/)**, um eine ansprechende Spielwelt zu gestalten.
|
||
|
||
Die Arbeit von Kenney ist eine unglaubliche Ressource für die Spieleentwicklung, da er hochwertige Assets kostenlos zur Verfügung stellt. Wenn dir die Grafiken gefallen oder du sie in eigenen Projekten nutzen möchtest, schau bitte auf seiner Website vorbei!
|
||
|
||
> [!HEART]
|
||
> Unterstütze die tolle Arbeit von Kenney, indem du seine Assets direkt bei [Kenney.nl](https://kenney.nl/) herunterlädst oder ihn dort unterstützt.
|
||
|
||
|
||
---
|
||
|
||
## 🛠 Installation & Setup
|
||
|
||
Möchtest du das Projekt lokal testen? Du kannst es entweder über Git klonen oder als ZIP-Archiv herunterladen.
|
||
> **Hinweis:** Damit alles problemlos funktioniert, muss sich die Brille für alle Wege im **Entwicklermodus** (Developer Mode) befinden.
|
||
|
||
### Option 1: Git Repository klonen
|
||
1. Öffne dein Terminal und führe folgenden Befehl aus:
|
||
``git clone https://gitty.informatik.hs-mannheim.de/2110867/Paradox_VR.git``
|
||
2. Starte den Godot Editor und klicke auf die Schaltfläche Importieren.
|
||
3. Wähle den Ordner des geklonten Projekts aus.
|
||
|
||
### Option 2: Download als ZIP
|
||
|
||
1. Lade das Repository als ZIP-Datei herunter und entpacke es (optional).
|
||
2. Öffne Godot und wähle Importieren.
|
||
3. Wähle die ZIP-Datei oder den entpackten Ordner aus.
|
||
|
||
> **Hinweis:** Ab Godot Version 4.5 können ZIP-Dateien direkt importiert werden, sofern sie ein gültiges Godot-Projekt enthalten. Bei einer Ältern Version von Godot müssen Projkete voher entpackt werden
|
||
|
||
### Option 3: APK-Installation ohne Godot Engine (via SideQuest)
|
||
|
||
1. Laden Sie die Android-APK direkt von hier herunter: [APK](./APK/)
|
||
2. Laden Sie das Programm [SideQuest](https://sidequestvr.com/setup-howto) herunter und installieren Sie es.
|
||
3. Öffnen Sie die SideQuest-App auf Ihrem Desktop und verbinden Sie die VR-Brille per USB-Kabel mit dem PC.
|
||
4. Suchen Sie in der oberen Leiste nach dem Symbol, das wie eine Box mit einem Pfeil nach unten aussieht ("Install APK file from folder"). Klicken Sie darauf und wählen Sie die heruntergeladene APK-Datei aus.
|
||
5. Sobald die Installation abgeschlossen ist, finden Sie das Spiel in Ihrer VR-Bibliothek unter der Kategorie **"Unbekannte Quellen"**.
|
||
|
||
> **Hinweis:**
|
||
> Falls Sie die SideQuest-Desktop-App zum ersten Mal verwenden, müssen Sie diese eventuell noch einrichten. Hilfestellung dazu finden Sie in diesem Video: [SideQuest Setup Guide](https://www.youtube.com/watch?v=wNku19Hl9Dw&t=246s).
|
||
|
||
---
|
||
|
||
## 🥽 Android & VR Konfiguration
|
||
|
||
Um später APK-Dateien für eine VR-Brille (z. B. Meta Quest) zu erstellen, müssen die Engine-Einstellungen korrekt gesetzt sein:
|
||
|
||
1. Gehe in Godot zu den Editor Settings (Engine-Einstellungen).
|
||
|
||
2. Navigiere zum Bereich Android.
|
||
|
||
3. Hinterlege dort die korrekten Pfade für:
|
||
- Java SDK Path
|
||
- Android SDK Path
|
||
|
||
|
||
---
|
||
|
||
## ⚠️ Wichtige Hinweise (Troubleshooting)
|
||
|
||
Gradle-Berechtigungen
|
||
|
||
Falls Gradle beim Erstellen der APK Probleme macht, fehlen dem Script oft die nötigen Ausführungsrechte. Um dies zu beheben, öffne ein Terminal im Projektordner und führe (unter Linux oder macOS) folgende Befehle aus:
|
||
|
||
```bash
|
||
cd android/build
|
||
chmod +x gradlew
|
||
chmod +x ../gradlew
|
||
````
|
||
|
||
---
|
||
|
||
## Credits
|
||
| Name | Matrikelnummer |
|
||
| :--- | :--- |
|
||
| Tobias Heid | 2110867 |
|
||
| Kai Sellmann | - |
|
||
| Laurent Derguti| - |
|
||
| Josef Peskin | - |
|
||
| Daniel Lehmann| - |
|
||
| Pietro Orazio | - |
|
||
|
||
|