Docs: add Readme for Raindrop.Bootstrap

This commit is contained in:
alexiscatnip
2022-08-06 02:43:06 +08:00
committed by alexiscatnip
parent f1a311c28b
commit 1940b06d60
2 changed files with 28 additions and 0 deletions
+25
View File
@@ -0,0 +1,25 @@
## Raindrop.Bootstrap
Contains code and scenes that boots up the app.
### Booting up flowchart:
#### 1. Unity loads the default scene `BootstrapScene.unity`
This scene solely contains `RaindropBootstrapper.cs`, which calls methods to set up logger, static assets folder, etc.
After all that, `RaindropBootstrapper.cs` starts the LibreMetaverse library, which is dependent on all the above-mentioned.
As a final step, `RaindropBootstrapper.cs` registers `RaindropInstance` to the `ServiceLocator` Singleton.
#### 2. Load Game Scene: `MainScene.unity`
When `RaindropBootstrapper.cs` finishes setting up the environment, it loads the scene `MainScene.unity`.
`MainScene.unity` contains most of the visible parts of Raindrop Viewer:
- entire UI
- world-space rendered elements/ meshes (map, etc)
- the overall scene-hierachy for avatar, object, and sims.
Since these elements have dependency on the `LibreMetaverse` library, that's why they are solely in this scene. (I have suffered too many null reference exceptions)
+3
View File
@@ -0,0 +1,3 @@
fileFormatVersion: 2
guid: 8d3f15e4a46843f2a740ccbc8d0ecdd4
timeCreated: 1657637967