-
Notifications
You must be signed in to change notification settings - Fork 16
Folder structure
Sebastian edited this page Apr 1, 2020
·
6 revisions
The following structure is found in the root folder of this repository. Note: This is the intended folder structure, the project does not follow this structure consistently yet.
-
3d-models/
-
3d-model-1/
- Contains files for this 3d-model and related files
-
3d-model-2/
- Contains files for this 3d-model and related files
- ...
-
-
gimp/
(maybe rename totextures/
orimages/
or merge withimages/
folder)- Contains project files of image editing software (gimp, photoshop, etc.)
- Exports from these project files are included in the unity project
-
images/
- Contains screenshots of the project, logos, icons, images used in the readme and similar files
-
unity/
- Contains the unity project
-
Assets/
-
0Refactored/
(rename toMaroon/
)- Contains all relevant assets for Maroon. The idea is to have all of our unity assets structured in this folder so that all files that are part of a plugin or imported external asset can stay our of this folder. Imported assets often have a different naming convention and break or are difficult to update if moved from their default location.
-
reusableBase/
- Contains reusable/global base assets such as the player or the camera
-
reusableFonts/
- Contains fonts
-
reusableGui/
- Contains reusable user interface elements
-
reusableImages/
- Contains central images such as logos or icons
-
reusableMaterials/
- Contains materials that occur often in the project (such as materials for walls and floors)
-
reusablePrefabs/
(maybe split this to reusableModels, reusableVisualizations etc.)-
prefab-1/
- Contains reusable prefabs and all related assets (materials, scripts, etc.) only used for this prefab
prefab-2/
- ...
-
-
scenes/
(rename torooms/
maybe?)laboratory/
menu/
-
experiments/
-
experiment-1/
- Contains all assets (prefabs, scripts, materials, scenes, etc.) that are only used for this room
experiment-2/
- ...
-
-
0Unused
- Contains all assets that are imported to but not used in the project. These files should either be refactored to be usable again or deleted from the project.
-
WebGLTemplates/
- Contains WebGL-Export templates
-
MaroonWeb/
- Contains the Maroon WebGL-template
-
The ultimate guide to contribute to Maroon
General
🏠 Home
📑 Software versions
🔬 Experiments
Workflow
🔗 Git workflow
Conventions
💬 Naming things
🗃️ Folder structure
📦 Including components
📃 Scripts
🌄 Scene Layout
🎨 Materials
🗿 3D Models
🔉 Audio
🔤 Typography
Documentation
🎮 Input
🏭 Generated laboratory
👪 Multiplayer