Files and Folders - WEKIT-ECS/MIRAGE-XR GitHub Wiki
![warning] Be careful about the placement of the
asmdeffiles, as they determine into which DLL the script is compiled (and whether the DLL needs to be updated and compiled fresh). All scripts in the same folder as the asmdef file or in child folders are grouped together for the compilation.
Pay close attention when renaming folders, as some need to have special names for Unity to pick up on. We removed the top-level Editor as it is ambiguous and Unity uses this as a special name for UI elements inside the Unity editor. Objects in a Resources folder are loadable by script with a special method, but these assets are also always compiled into the build, no matter whether we use them or not. So, check carefully whether assets actually need to be in such Resources folder when placing them, and sort them into the according Resources sub-folders of folders to have it nice and tidy (e.g. Config/Resources).
| File | Description |
|---|---|
| Automation | This is where build scripts etc. belong |
| Common | Common images, shaders, models |
| Config | Home to the design time configuration files (including calibration images and deep links class) |
| ContentTypes | Each augmentation content type has its own folder here (e.g. 3DModel, Image, VirtualInstructor) |
| Controllers | Mostly legacy, but some important classes (Login)? |
| Design | Models, fonts, Materials; Mobile and Spatial UI prefabs; common UI elements |
| GeneralMedia | Fonts |
| Logo | App icons, splash screen |
| Managers | Core functionalities (all attached to Start scene and RootObject |
| Networking | The XR collaboration functionality with avatar system |
| Player | Mobile and Spatial business logic scripts; and a lot of legacy |
| Prefabs | Spatial UI prefabs (some); Unused XR keyboard (prep for Android XR) |
| ReadyPlayerMe | RPM business logic |
| Rendering | Universal Rendering Pipeline config and shaders list |
| Resources | Camera prefabs, Diamond prefab, some legacy? |
| Scenes | Start resides here (and some others) |
| Scripts | Grid, Logger, Polyspatial Utilities, new mobile UI, and a lot of legacy? |
| Search | Some Grid functionality here |
| Services | xAPI, Watson, MQTT, Sketchfab (legacy), openAI (legacy) |
| StyleCop.Analyzers | Config for Stylecop, which we use to check formatting etc. in automated PR reports |
| Tests | Some Tests (legacy?) |
| Tutorial | Tutorial Manager and components |
| UnitTests | The unit testing framework and test scripts |
| Utility.UiKit | More spatial and mobile UI - generic components (buttons, etc.) |
| View | Some views for mobile/spatial UI? |