From 5c32e7a9ef729702a0d61d9f0114264ef4632026 Mon Sep 17 00:00:00 2001
From: Selim Eser <2211482@stud.hs-mannheim.de>
Date: Sat, 24 Jan 2026 20:18:38 +0100
Subject: [PATCH] Added README

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2f06556
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# Years Apart - Installationsanleitung
+
+Dieses Repository enthält den Source Code für das VR-Puzzlespiel **Years Apart**.
+Zielplattform: **Meta Quest 3**.
+
+Es gibt zwei Möglichkeiten, das Spiel auf die Brille zu bringen:
+1. **Quick Install (Empfohlen):** Installation der fertigen `.apk` Datei.
+2. **Build from Source:** Projekt in Godot öffnen und selbst deployen.
+
+---
+
+## Methode 1: Quick Install (via APK & SideQuest)
+
+Diese Methode ist am schnellsten, wenn du das Spiel nur spielen möchtest.
+
+### Voraussetzungen
+*   Eine **Meta Quest 3** im **Entwicklermodus** (Developer Mode).
+    *   *Anleitung:* Gehe in die Meta Quest Handy-App -> Einstellungen -> Headset-Einstellungen -> Entwicklermodus -> Ein.
+*   Ein USB-C Kabel zum Verbinden der Brille mit dem PC.
+*   [SideQuest](https://sidequestvr.com/setup-howto) (Advanced Installer) oder der [Meta Quest Developer Hub](https://developer.oculus.com/meta-quest-developer-hub/) auf deinem PC installiert.
+
+### Schritte
+1.  Lade die aktuelle **Release-APK** (`YearsApart.apk`) hier herunter:
+    *   [🔗 Zum Release Download](https://gitty.informatik.hs-mannheim.de/2211482/vrp-years-apart/releases)
+2.  Verbinde deine Quest 3 via USB mit dem PC und erlaube den USB-Zugriff in der Brille.
+3.  Öffne **SideQuest**. Oben rechts sollte der Status grün sein ("Connected").
+4.  Klicke in SideQuest oben rechts auf das Icon **"Install APK file from folder on computer"** (Pfeil nach unten über einer Box).
+5.  Wähle die heruntergeladene `.apk` Datei aus.
+6.  Warte, bis SideQuest "All tasks completed" meldet.
+
+**Spiel starten:**
+In der Quest 3 findest du das Spiel in der Bibliothek unter **Quellen** (oben rechts im Filter) -> **Unbekannte Quellen** (Unknown Sources).
+
+---
+
+## Methode 2: Build from Source (via Godot Engine)
+
+Nutze diese Methode, wenn du den Code bearbeiten oder debuggen möchtest.
+
+### Voraussetzungen
+*   **Godot Engine 4.x** (Die Version, mit der das Projekt erstellt wurde).
+*   **Android SDK & OpenJDK 17**:
+    *   Godot muss für den Android-Export konfiguriert sein.
+    *   Gehe in Godot zu `Editor` -> `Editor Settings` -> `Export` -> `Android` und stelle sicher, dass die Pfade zum Android SDK und Java SDK gesetzt sind.
+*   Die Quest 3 im **Entwicklermodus** (siehe oben).
+
+### Schritte
+1.  **Repository klonen:**
+    ```bash
+    git clone https://gitty.informatik.hs-mannheim.de/2211482/vrp-years-apart.git
+    ```
+2.  **Projekt öffnen:**
+    Starte Godot und importiere die `project.godot` Datei aus dem Ordner.
+3.  **Verbindung herstellen:**
+    Verbinde die Quest 3 via USB. Erlaube USB-Debugging in der Brille, falls gefragt.
+4.  **Remote Deploy:**
+    *   Oben rechts im Godot Editor sollte nun ein **Android-Icon** sichtbar sein (neben den Play-Buttons), oder unter "Remote Debug".
+    *   Klicke auf das Icon ("Remote Debug" / "Run on Android Device").
+    *   Godot kompiliert das Projekt und installiert es direkt auf der Brille. Das Spiel startet automatisch.
+
+*(Hinweis: Falls dies der erste Build ist, stelle sicher, dass unter `Project` -> `Export...` ein Android-Preset angelegt ist und die Option "XR Mode" auf "OpenXR" steht.)*
\ No newline at end of file