Unity - es ist eine leistungsstarke Engine für die Spieleentwicklung, mit der Sie Spielprojekte für verschiedene Plattformen wie Windows, macOS, iOS, Android und viele andere erstellen können. Ihr Projekt kann eine große Anzahl von Dateien enthalten, die für die Versionsverfolgung mit Git möglicherweise unnötig sind. Sie können eine Datei verwenden, um unnötige Informationen nicht im Versionskontrollsystem zu speichern .gitignore. In diesem Artikel werden wir uns ansehen, wie gitignore für ein Unity-Projekt richtig konfiguriert wird.
.gitignore - Dies ist eine Datei in Git, mit der Sie die ignorierten Dateien und Ordner angeben können. Wenn Git diese Datei im Stammverzeichnis des Projekts findet, wird alles, was darin angegeben ist, ignoriert. Es ist wichtig zu verstehen, dass .gitignore löscht keine Dateien und Ordner aus Ihrem Repository - es wird ihre Änderungen einfach nicht verfolgen.
Wenn Sie mit einem Unity-Projekt arbeiten, sollten Sie Folgendes hinzufügen .gitignore die folgenden Dateien und Ordner:
# Unity generated folders
Library/
Temp/
Logs/
Build/
Assets/AssetStoreTools*
# Play mode temp files
UnityLockfile
In der Datei .gitignore sie können nicht nur Dateinamen und Ordner angeben, die ignoriert werden sollen, sondern auch Sonderzeichen verwenden. Ein Sternchen (*) am Ende einer Zeile weist beispielsweise darauf hin, dass alle Dateien und Ordner, die mit der angegebenen Zeile beginnen, ignoriert werden.
Problem mit gitignore in Unity: Wie richte ich wichtige Dateien ein?
Wenn Sie mit Unity und Git arbeiten, müssen Sie das gitignore der Datei richtig konfigurieren, um Probleme beim Speichern und Synchronisieren unnötiger oder temporärer Dateien zu vermeiden. Eine falsche Konfiguration von gitignore kann zu unerwünschten Folgen führen, z. B. zum Überschreiben wichtiger Daten oder zu Zusammenführungskonflikten.
Die Gitignore-Datei dient dazu, Git anzugeben, welche Dateien und Ordner nicht verfolgt oder dem Repository hinzugefügt werden sollen. Im Falle von Unity gibt es einige wichtige Dateien und Ordner, die in gitignore korrekt konfiguriert werden müssen.
Die wichtigsten Dateien, die zu gitignore in Unity hinzugefügt werden müssen:
- .vs : ein Ordner mit Visual Studio-Einstellungen, die von verschiedenen Entwicklern unterschiedlich sein können. Sie sollten diesen Ordner nicht im Repository verfolgen.
- Library : Ein Ordner, der zwischengespeicherte Daten enthält, die von Unity generiert wurden (z. B. kompilierte Skripte, vorkompilierte Shader usw.). Sie müssen diesen Ordner aus dem Repository ausschließen, um Zusammenführungskonflikte zu vermeiden und Speicherplatz zu sparen.
- Temp : Ein Ordner mit temporären Dateien, die von Unity während der Arbeit generiert werden. Sie sollten diesen Ordner nicht im Repository verfolgen.
- Build : Der Ordner, der die gesammelten Versionen des Spiels enthält. In den meisten Fällen sollten diese Dateien nicht in das Repository gelangen, da sie groß sein können und nicht versioniert werden können.
- .unityproj : Eine Unity-Projektdatei. Es ist normalerweise groß und kann zu Synchronisierungs- und Zusammenführungsproblemen führen. Es wird empfohlen, es aus dem Repository auszuschließen.
Zusätzlich zu den angegebenen Dateien und Ordnern sollten Sie gitignore auch weitere Dateien und Ordner hinzufügen, die möglicherweise für Ihr Projekt spezifisch sind. Dies können temporäre Dateien sein, die vom Unity-Editor oder anderen Tools erstellt wurden, Anpassungen und Projektdateien, die für die Zusammenarbeit und Versionierung nicht benötigt werden.
Die korrekte Konfiguration der Datei gitignore in Unity vermeidet Synchronisierungsprobleme, spart Speicherplatz, beschleunigt Commit- und Aktualisierungsvorgänge und vereinfacht das Zusammenführen von Änderungen.
Was ist gitignore in Unity?
Mit Gitignore in Unity können Sie nicht benötigte Dateien wie lokale Projekteinstellungen, Build-Dateien, temporäre Dateien, Caches und andere Dateien, die für das Projekt selbst nicht relevant sind oder Konflikte bei der Zusammenarbeit verursachen können, von der Versionskontrolle ausschließen.
Um eine gitignore-Datei in Unity zu erstellen, müssen Sie eine neue Datei mit dem Namen "erstellen.gitignore" im Stammverzeichnis des Projekts oder in einem Verzeichnis mit einem aktiven Git-Repository. Sie müssen dieser Datei Zeilen mit Vorlagen für ignorierte Dateien und Ordner hinzufügen.
Beispiele für ignorierte Dateien und Ordner in gitignore Unity:
- Library/ - ignoriere den gesamten Library-Ordner, der Caches und temporäre Dateien enthält
- Temp/ - ignoriere den gesamten Temp-Ordner, der temporäre Projektdateien enthält
- Obj/ - ignoriere den gesamten Obj-Ordner, der die Build-Dateien des Projekts enthält
- *.csproj - ignoriere alle Dateien mit der Erweiterung .csproj
- *.sln - ignoriere alle Dateien mit der Erweiterung .sln
Nachdem Sie eine gitignore-Datei erstellt und konfiguriert haben, ignoriert Git die angegebenen Dateien und Ordner automatisch, wenn Sie die Befehle git add und git commit ausführen.
Mit gitignore in Unity können Sie vermeiden, dass große Dateien unnötig zum Git-Repository hinzugefügt werden, den Commit-Prozess beschleunigen und die Projektzusammenarbeit verbessern.
Welche Dateien sollten in gitignore Unity ausgeschlossen werden?
Wenn Sie mit Unity in einem Git-Repository arbeiten, müssen Sie die Datei ordnungsgemäß konfigurieren.gitignore, um unnötige Dateien und Ordner auszuschließen, die nicht in Commits enthalten sein sollten. Hier ist eine Liste von Dateien und Ordnern, die normalerweise ausgeschlossen werden sollten:
| Datei/Ordner | Die Beschreibung |
|---|---|
| Library/ | Ein Ordner mit Unity-Daten, der beim Start des Projekts automatisch generiert wird. Enthält kompilierte Skripte, vorkompilierte Shader und andere Daten, die mit dem Rebild des Projekts wiederhergestellt werden können. |
| Temp/ | Ein Ordner mit temporären Dateien, der ebenfalls von Unity generiert wird. Enthält temporäre Daten, die wiederhergestellt werden können. |
| Obj/ | Ein Ordner, der zum Speichern von Objektdateien verwendet wird, die wiederhergestellt werden können. |
| Build/ | Ein Ordner mit den erstellten ausführbaren Dateien oder Projekt-Builds. Sie können aus dem Quellcode wiederhergestellt werden. |
| .vs/ | Ein Ordner, der Visual Studio zugeordnet ist und die Projektdaten enthält, die wiederhergestellt werden können. |
| .idea/ | Ein Ordner, der der JetBrains IDE zugeordnet ist (z. B. IntelliJ IDEA oder PyCharm), der die Projektdateien enthält, die wiederhergestellt werden können. |
| *.csproj | C# -Projektdateien, die mithilfe einer Projektassembly wiederhergestellt werden können. |
| *.sln | Projektmappendateien, die mithilfe der Projektassembly wiederhergestellt werden können. |
Dies sind nur einige der häufigsten Dateien und Ordner, die bei der Arbeit mit Unity in Git ausgeschlossen werden sollten. Abhängig von den Besonderheiten Ihres Projekts können jedoch auch andere Dateien oder Ordner vorhanden sein, die ebenfalls ausgeschlossen werden sollten. Denken Sie daran, dass das Ausschließen dieser Dateien und Ordner die Größe des Repositorys optimiert und die Zusammenarbeit am Projekt erleichtert.
Wie kann ich gitignore in Unity erstellen und richtig konfigurieren?
Schritt 1: Erstellen Sie die Datei .gitignore
Um eine gitignore-Datei in Unity zu erstellen, öffnen Sie den Projektstammordner in einem beliebigen Texteditor oder einer Entwicklungsumgebung wie Visual Studio Code oder Notepad++. Wenn die Datei .gitignore existiert bereits, Sie können diesen Schritt überspringen.
Schritt 2: Hinzufügen von Standardvorlagen
Unity stellt einige Standard-Gitignore-Vorlagen bereit, die Sie in Ihrem Projekt verwenden können. Diese Vorlagen enthalten vordefinierte Regeln zum Ignorieren verschiedener Unity-bezogener Dateien und Ordner. Sie können eines dieser Vorlagen kopieren und zu Ihrer gitignore-Datei hinzufügen:
-
Eine sehr grundlegende Vorlage:
# Unity/[Ll]ibrary//[Tt]emp//[Oo]bj//[Bb]uild//[Bb]uilds//Assets/AssetStoreTools*# Visual Studio cache directory/.vs/# Autogenerated VS/MD/Consulo solution and project filesExportedObj/.consulo/*.csproj*.unityproj*.sln*.suo*.tmp*.user*.userprefs*.pidb*.booproj*.svd# Unity3D generated meta files*.pidb.meta# Unity3D Generated File On Crash Reportssysinfo.txt# Builds*.apk*.unitypackage# Unity LFS/[Ll]ibrary/lock*/[Tt]emp/*.log/[Tt]emp/*.tmp/[Tt]emp/[Vv]s//[Tt]emp/UnityLockfile/[Oo]bj//[Bb]uild//[Bb]uilds//[Bb]uilds-[Tt]emp//[Dd]eprecated//[Pp]ackages/manifest.json/[Pp]ackages/packages-lock.json/Packages/manifest.json/Packages/packages-lock.json/ProjectSettings/ProjectSettings.assetWählen Sie eine geeignete Vorlage aus und fügen Sie ihren Inhalt zu Ihrer gitignore-Datei hinzu. Diese Vorlagen enthalten normalerweise das Ignorieren des Ordners Library, der Zwischendaten zu Assets und Szenen enthält, sowie die Ordner Temp, Obj, Build und Builds, die die temporären und intermediären Unity-Dateien enthalten.
Schritt 3: Eigene spezifische Regeln hinzufügen
Nachdem Sie die Standardvorlagen hinzugefügt haben, können Sie Ihrer gitignore-Datei Ihre spezifischen Regeln hinzufügen. Sie können beispielsweise angeben, dass Git Projektkonfigurationsdateien oder persönliche Entwicklerdaten ignoriert. Es ist wichtig zu beachten, dass Sie gitignore keine Dateien hinzufügen sollten, die zum Erstellen oder Ausführen eines Projekts auf anderen Computern oder Geräten erforderlich sind.
Beispiele für spezifische Regeln:
-
Ignorieren von IDE-Konfigurationsdateien:
# Visual Studio*.sln*.csproj*.userprefs# Rider.idea/# Local project settingsUnityProjectSettings.jsonEditorUserSettings.json# Personal developer data/dev_data/# Keys and passwords*.pem*.key*.pfx*.cer*.jksDenken Sie daran, die Änderungen zu speichern, nachdem Sie Ihre spezifischen Regeln hinzugefügt haben.
Schritt 4: Festlegen von Regeln für das Repository
Nachdem Sie alle erforderlichen Regeln hinzugefügt haben, besteht der nächste Schritt darin, diese Regeln für Ihr Git-Repository festzulegen. Führen Sie dazu einfach den Befehl git add aus.gitignore im Stammordner des Projekts. Danach werden die Änderungen an der gitignore-Datei in der "staged" -Phase angezeigt und in das nächste Commit aufgenommen.
Führen Sie dann den Befehl git commit -m "Add " aus.gitignore file" um ein neues Commit mit der hinzugefügten gitignore-Datei zu erstellen. Führen Sie schließlich den Befehl git push aus, um das Commit an das Remote-Repository zu senden.
Ihre gitignore-Datei sollte jetzt funktionieren und unnötige und temporäre Dateien im Unity-Projekt ordnungsgemäß ignorieren, sodass Sie das Repository effizienter verwalten können.
