| ... | ... | @@ -39,10 +39,10 @@ Bitte folgen Sie der Anleitung Schritt für Schritt und halten Sie sich an die e |
|
|
|
|
|
|
|
In diesem Abschnitt wird die Installation und Einrichtung von GitHub Desktop sowie Git LFS (Large File Storage) erläutert. GitHub Desktop ist eine benutzerfreundliche, grafische Oberfläche, die das Verwalten und Synchronisieren von Git-Repositories erleichtert, ohne dass Befehle in der Kommandozeile erforderlich sind. Dies vereinfacht insbesondere die Zusammenarbeit und Versionskontrolle, was für figments.nrw und den Austausch von Lerninhalten, die damit erstellt wurden, hilfreich ist.
|
|
|
|
|
|
|
|
> [!danger]+ Hinweis
|
|
|
|
> **Hinweis**
|
|
|
|
> Regelmäßige Sicherungen (Commits) Ihrer Arbeit sind essenziell, um Datenverlust zu vermeiden und bei Fehlern einfach auf vorherige Versionen zurückzugreifen. GitHub Desktop erleichtert dies, indem es Versionsstände übersichtlich anzeigt und sichert.
|
|
|
|
|
|
|
|
> [!tip]- Fortgeschrittene Anwender\*innen
|
|
|
|
> **Fortgeschrittene Anwender\*innen**
|
|
|
|
> Sie können natürlich auch fortgeschrittenere Lösungen verwenden oder ganz auf die Versionierung verzichten.
|
|
|
|
|
|
|
|
---
|
| ... | ... | @@ -78,7 +78,6 @@ Unity ist eine plattformübergreifende Entwicklungsumgebung, die für figments.n |
|
|
|
2. Installieren Sie Unity Hub, indem Sie dem Installationsassistenten folgen.
|
|
|
|
3. Starten Sie Unity Hub nach der Installation.
|
|
|
|
|
|
|
|
> [!info]
|
|
|
|
> **Systemvoraussetzungen:** Stellen Sie sicher, dass Ihr Computer die Hardwareanforderungen für Unity erfüllt. Unity erfordert in der Regel mindestens 8 GB RAM und 20 GB freien Speicherplatz.
|
|
|
|
|
|
|
|
### Einrichtung eines Unity-Kontos
|
| ... | ... | @@ -91,7 +90,7 @@ Für die Nutzung von Unity Hub ist ein Unity-Konto erforderlich. Dieses Konto ka |
|
|
|
|
|
|
|
### Installation von Unity
|
|
|
|
|
|
|
|
![[img_installation_unity-version.png]]
|
|
|
|
|
|
|
|
|
|
|
|
1. Suchen Sie nach der Version **2021.3.5f1** im Unity-Archiv: [Unity Archive](https://unity.com/releases/editor/archive).
|
|
|
|
2. Klicken Sie auf **Install**
|
| ... | ... | @@ -103,7 +102,6 @@ Für die Nutzung von Unity Hub ist ein Unity-Konto erforderlich. Dieses Konto ka |
|
|
|
3. (optional) Falls Sie planen, eine Server-Version von Figments.nrw zu erstellen:
|
|
|
|
`Linux Build Support (IL2CPP)`, `Linux Dedicated Server Build Support`
|
|
|
|
|
|
|
|
> [!warning]
|
|
|
|
> **Installation nur über Unity Hub:** Laden Sie die Version 2021.3.5f1 nicht direkt von der Unity-Website herunter, sondern nutzen Sie den Install-Button im Unity-Archiv. Dies stellt sicher, dass die Version korrekt in Unity Hub integriert wird.
|
|
|
|
|
|
|
|
---
|
| ... | ... | @@ -114,7 +112,7 @@ Figments.nrw ist ein Open-Source-Framework für Unity zur Erstellung immersiver |
|
|
|
|
|
|
|
## Download mit Github Desktop
|
|
|
|
|
|
|
|
![[img_installation_github-desktop_existing-installation.png]]
|
|
|
|
|
|
|
|
|
|
|
|
Wir empfehlen, Figments.nrw über GitHub Desktop herunterzuladen:
|
|
|
|
|
| ... | ... | @@ -128,7 +126,7 @@ Wir empfehlen, Figments.nrw über GitHub Desktop herunterzuladen: |
|
|
|
> [!tip]
|
|
|
|
> Wenn Sie aufgefordert werden, Git LFS zu initialisieren, können Sie dies bestätigen. Git LFS verwaltet große Dateien effizient und verbessert die Leistung bei Unity-Projekten.
|
|
|
|
|
|
|
|
> [!info]- Direkt-Download
|
|
|
|
> **Direkt-Download**
|
|
|
|
> Sie können Figments.nrw auch direkt herunterladen: [Download-Link](https://git.uni-wuppertal.de/tmdt-iel/figments.nrw/-/archive/main/figments.nrw-main.zip)
|
|
|
|
> Das Archiv müssen Sie anschließend nur noch entpacken und zu [[#Figments.nrw in Unity Hub einbinden|Unity Hub]] hinzufügen.
|
|
|
|
> **Wir empfehlen, trotz des Mehraufwands, mit Github Desktop zu arbeiten. Dies vereinfacht sowohl die Bereitstellung von Aktualisierungen, als auch die Sicherung Ihrer eigenen Arbeiten in Figments.nrw.**
|
| ... | ... | @@ -138,7 +136,7 @@ Wir empfehlen, Figments.nrw über GitHub Desktop herunterzuladen: |
|
|
|
|
|
|
|
In den meisten Fällen können Sie direkt im `main` Branch arbeiten, vor allem, wenn Sie figments.nrw zuerst kennenlernen und grundlegende Tests durchführen möchten. Der `main` Branch enthält die stabile Version des Projekts und sollte stets durch einen **Pull** auf den neuesten Stand gebracht werden, bevor Sie das Projekt in Unity starten.
|
|
|
|
|
|
|
|
![[img_installation_branches.png]]
|
|
|
|
|
|
|
|
|
|
|
|
Falls Sie jedoch eigene Inhalte erstellen oder größere Änderungen planen, empfehlen wir, dafür einen eigenen Branch anzulegen. So bleibt der Hauptzweig stabil und Ihre Anpassungen sind getrennt, wodurch das Projekt für andere Nutzer*innen übersichtlich bleibt.
|
|
|
|
|
| ... | ... | @@ -147,7 +145,7 @@ Falls Sie jedoch eigene Inhalte erstellen oder größere Änderungen planen, emp |
|
|
|
1. Klicken Sie dazu zunächst auf `Fetch Origin`
|
|
|
|
2. Wenn eine neue Version vorliegt, können Sie diese mit `Pull` herunterladen
|
|
|
|
|
|
|
|
> [!info]+ Info
|
|
|
|
> **Info**
|
|
|
|
> Für den allgemeinen Einsatz und zum Erkunden von figments.nrw ist das Arbeiten im `main` Branch ausreichend. Sollten Sie jedoch planen, eigene Funktionen und Erweiterungen beizutragen, folgen Sie bitte den untenstehenden Empfehlungen zur Arbeit in Branches.
|
|
|
|
|
|
|
|
### Branching und Workflow
|
| ... | ... | @@ -165,7 +163,7 @@ Falls Sie jedoch eigene Inhalte erstellen oder größere Änderungen planen, emp |
|
|
|
|
|
|
|
## Figments.nrw in Unity Hub einbinden
|
|
|
|
|
|
|
|
![[img_installation_add-project-to-hub.png]]
|
|
|
|
|
|
|
|
|
|
|
|
Nachdem das Repository lokal gespeichert wurde, können Sie das Projekt nun in Unity öffnen:
|
|
|
|
|
| ... | ... | @@ -178,12 +176,12 @@ Nachdem das Repository lokal gespeichert wurde, können Sie das Projekt nun in U |
|
|
|
## Figments.nrw starten
|
|
|
|
|
|
|
|
1. Öffnen Sie Unity Hub und klicken Sie auf den Projektnamen **FigmentsNRW**, um das Projekt zu starten.
|
|
|
|
> [!warning]+ Update-Warnungen
|
|
|
|
> **Update-Warnungen**
|
|
|
|
> Unity wird möglicherweise Updates für Komponenten wie unseren Avatar-Service ReadyPlayer.me vorschlagen.
|
|
|
|
> **Bitte lehnen Sie diese Updates ab, da sie zu Kompatibilitätsproblemen führen können!**
|
|
|
|
|
|
|
|
2. Nach dem Start sind Unity und figments.nrw einsatzbereit.
|
|
|
|
> [!failure]- Bei Fehlermeldungen und Problemen
|
|
|
|
> **Bei Fehlermeldungen und Problemen**
|
|
|
|
> Falls Fehler oder Probleme auftreten, besuchen Sie bitte den Abschnitt [[#Troubleshooting]].
|
|
|
|
|
|
|
|
Um sich mit Figments.nrw vertraut zu machen, können Sie unser Einstiegstutorial nutzen. Diese finden Sie sowohl direkt in Figments.nrw (unter `Assets/Tutorials`) als auch auf unserer [Website](https://www.figments.nrw/tutorials).
|
| ... | ... | @@ -200,21 +198,21 @@ In diesem Abschnitt finden Sie Lösungen zu häufig auftretenden Problemen und H |
|
|
|
|
|
|
|
## Häufige Probleme und Lösungen
|
|
|
|
|
|
|
|
> [!failure]- Projekt enthält Kompilerfehler
|
|
|
|
> ![[img_installation_compiler-error.png|300]]
|
|
|
|
> **Projekt enthält Kompilerfehler**
|
|
|
|
> 
|
|
|
|
>
|
|
|
|
> In seltenen Fällen können sich Fehler im Quellcode auch auf dem `main` Branch wiederfinden. Unity wird diese mit oben stehender Fehlermeldung quittieren, sie können das Projekt aber dennoch häufig regulär öffnen. Da der Code aber nicht ausgeführt werden kann, lässt sich Figments.nrw in diesen Fällen nicht starten.
|
|
|
|
>
|
|
|
|
> > [!success]- Lösung
|
|
|
|
> > **Lösung**
|
|
|
|
> > - Bitte erstellen Sie einen möglichst detaillierten Fehlerbericht in unserem Ticketsystem:
|
|
|
|
> > https://git.uni-wuppertal.de/tmdt-iel/figments.nrw/-/issues
|
|
|
|
|
|
|
|
> [!failure]- Git Variable fehlt - Unity startet im Safe Mode
|
|
|
|
> ![[img_installation_error-git-path.png|300]]
|
|
|
|
> **Git Variable fehlt - Unity startet im Safe Mode**
|
|
|
|
> 
|
|
|
|
>
|
|
|
|
> Wenn Unity beim Projektstart den Safe-Modus vorschlägt, könnte ein Problem mit den installierten Git- und Git LFS-Konfigurationen vorliegen.
|
|
|
|
>
|
|
|
|
> > [!success]- Lösung
|
|
|
|
> > **Lösung**
|
|
|
|
> > - Prüfen Sie, ob Git und Git LFS korrekt installiert sind und im Systempfad verfügbar sind.
|
|
|
|
> > - Für Windows können Sie sich die Einrichtung von Git LFS in diesem [YouTube-Video](https://youtu.be/F-8A8mJwL_Y) ansehen.
|
|
|
|
> > - Auf macOS führen Sie folgende Schritte aus:
|
| ... | ... | @@ -228,20 +226,20 @@ In diesem Abschnitt finden Sie Lösungen zu häufig auftretenden Problemen und H |
|
|
|
> > brew install git-lfs
|
|
|
|
> > ```
|
|
|
|
> >
|
|
|
|
> > > [!warning]
|
|
|
|
> > > **Hinweis**
|
|
|
|
> > > Nach der Installation von Git und Git LFS starten Sie das System neu, damit Unity die Änderungen erkennt.
|
|
|
|
|
|
|
|
> [!failure]- Fehlermeldungen zu fehlenden Komponenten
|
|
|
|
> **Fehlermeldungen zu fehlenden Komponenten**
|
|
|
|
> Unity kann Fehlermeldungen zu fehlenden Komponenten oder Assets anzeigen, wenn bestimmte Komponenten nicht korrekt geladen wurden.
|
|
|
|
>
|
|
|
|
> > [!success]- Lösung
|
|
|
|
> > **Lösung**
|
|
|
|
> > - Führen Sie im Unity Hub vor dem Start einen **Pull** im `main` Branch durch, um sicherzustellen, dass alle Dateien aktuell sind.
|
|
|
|
> > - Überprüfen Sie, ob Sie alle benötigten Unity-Pakete und Assets installiert haben. Falls Updates vorgeschlagen werden, lehnen Sie diese ab, um Kompatibilitätsprobleme zu vermeiden.
|
|
|
|
|
|
|
|
> [!failure]- Projekt lädt langsam oder stürzt ab
|
|
|
|
> **Projekt lädt langsam oder stürzt ab**
|
|
|
|
> Wenn das Projekt langsam lädt oder Unity unerwartet abstürzt, könnte dies an Hardware-Ressourcen oder an speicherintensiven Projektdateien liegen.
|
|
|
|
>
|
|
|
|
> > [!success]- Lösung
|
|
|
|
> > **Lösung**
|
|
|
|
> > - Stellen Sie sicher, dass Ihr System mindestens 20 GB freien Speicher und ausreichenden Arbeitsspeicher für das Projekt hat.
|
|
|
|
> > - Vermeiden Sie es, das Projekt in einem Cloud-Ordner (z. B. OneDrive) zu speichern, da dies zu Synchronisationsproblemen und Ladeverzögerungen führen kann.
|
|
|
|
|
| ... | ... | |
