-
Notifications
You must be signed in to change notification settings - Fork 5
ProjectStructure
This pages aims to provide an overview of the most important project files and where they are found:
Most directories in this directory are external plugins that are currently managed by git-lfs. Documentation for these plugins should be sought within that plugin's documentation.
The directories that are written by or managed by the SEE-developing people are explained below:
Everything concerning built-in editors.
TODO
TODO
The source code of SEE.
Plugins used in SEE.
Parsers required to show source code in code windows within SEE.
Resources like audio, video, fonts, prefabs, etc.
Tests for SEE that do not require UnityUI (editor-mode tests).
That separation is due to the CI/CD pipeline.
Tests for SEE that require UnityUI (play-mode tests).
The Unity scenes that we currently have.
More information here.
Additional data that should go into a build such as the GXL files for the examples in the scenes.
Everything related to the SEE Trailer (a video on SEE).
(Further questions: Rainer Koschke.)
Configuration files for the Axivion Dashboard.
(Further questions: Falko Galperin)
Data from software analyses that are to be visualized by SEE.
Attention: large GXL-Files ( > 1 MB) should be compressed with the xz-Format. Further information here.
Scripts managing Git's behaviour in this project. These files are executed before each git commit.
See Workflow for more information.
Settings for the Unity Package Manager.
If you install a new package, the manifest file is changed and has to be committed (if you want to propagate the package installation).
Project information files (asset files and project version...)
A plugin for Visual Studio (VS) so that SEE and VS can interact. Allows to show the source code of a game node selected in SEE in VS and vice versa.
Holds information about which files are managed by git lfs (large file storage).
Holds regexes for the files that git should not handle.
Git-LFS configuration files.
The classic README that is shown at the landing page of a GitHub project.
The root file for SEEs C# project.
(should not be of any concern for bachelor project students.)
This file generates csproj files (C# project files) to build the unity project (on Windows).
More information within the files comments.
These files copy the file run_all contained in /GitScripts/ to this
projects git pre-commit hooks directory.
generateHook.bat is for Windows and generateHook.sh for unix-like systems.
This file should be executed after cloning the repository and before comitting anything.
(See Workflow for more information.)