Need to document VR2Gather for experience developers

[jackjansen]

We need at least some developer documentation, and ideally before this Wednesday.

At the very least:

• High-level overview of how experience instances (pilots), scenes, orchestrator and streaming pipelines work together
• Walkthrough of the directory and assembly structure
  • Also github repositories, and how submodules are structured
  • Also Github Action infrastructure
• Explain about the 4 standard scenes (Pilot0, LoginManager, TechnicalPlayground, SoloPlayground)
• Walkthrough of how a normal experience scene is structured (using Pilot0 as an example)
  • Explain the SceneController and such objects
  • Explain that players are instantiated on the fly
• Explain important prefabs
  • P_Self_Player
  • P_Player
  • PFB_Button
  • PFB_Pilot0ButtonObject
  • Possibly mud balls and generator from #52
• Two things about players probably need special mention:
  • Direct interaction, Ray interaction, non-XR interaction and how it has been implemented that all of these work.
  • How the pipelines work.
• Road map for developing a new experience:
  • Create branch under development/
  • Create submodule to isolate new experience (both because of intellectual property/rights and checkout size)
  • Create Interactable objects
  • Create as prefab
  • First try out in SoloPlayground
  • Then check out in TechnicalPlayground
  • If you need something special in your player/self:
    • Create prefab with most of the stuff, name something like P_extras_xxxx
    • Create P_player_xxx and P_self_xxx as variants of player and self
    • Add the P_extra_xxxx and make any other changes
    • Add these prefabs in the scene controller

@nachoreimat @shirsub comments/additions please

[jackjansen]

Done and merged.

[jackjansen]

Need to add note about git lfs from the start of the subrepo.

[jackjansen]

That previous comment is no longer relevant, with the move to a unity package.