New scenario quick start

Documentation Index

Fetch the complete documentation index at: https://docs-unity.molca.id/llms.txt

Use this file to discover all available pages before exploring further.

​

Prerequisites

• Scenario scene is in File → Build Settings (and/or Addressables, if you load by reference).
• RuntimeManager prefab variant matches your needs (offline vs session, tour if applicable).
• Scenario Data Config exists on Global Settings.

​

1. Create simulation scenario data

1. Project window → Create → MolcaSDK → Scenario → Simulation Scenario Data (or equivalent menu for SimulationScenarioData).
2. Name the asset (e.g. Scenario_MyTraining).
3. In the Inspector, set:
   • Ref Id — stable id (auto-generated if empty).
   • Scenario name / description / tags / image — Home UI and metadata (DynamicLocalization entries are initialized from RefId in BaseScenarioData.Initialize()).
   • Time limit — Time Limit Seconds; 0 = no limit.
4. Scenario Activities — add ScenarioActivityData entries (each has Ref Id, titles, Activity Id / slug fields as defined on the type). These are the authoring records the runtime ScenarioActivity will match.
5. Scene loading — configure the SceneLoadPlan for your scenario:
   • Single Player Plan — expand Single Player Plan in the Inspector:
     • Scenario Scene — the main scenario logic scene (required). Set either Scene Name (build settings) or Scene Reference (Addressable — takes priority).
     • Preload Scenes — optional scenes loaded before the scenario scene (e.g., shared environment). Index 0 loads as Single (active scene); subsequent entries load Additive. Each entry can specify Wait For Ref Ids to pause loading until those RefIds are registered in ReferenceManager.
   • Role Scene Mappings — for multiplayer scenarios, configure per-role scene plans. Each mapping has a Role Id (matching a ScenarioRole.RefId) and its own SceneLoadPlan.

​

2. Create and lay out the scenario scene

1. Create or open the Unity scene referenced by the scenario asset.
2. Add the [VR Scenario] prefab (typical path: Assets/_MolcaSDK/_VR/Prefabs/Base/) — includes XR rig, scenario UI shell, and related objects (your project layout may vary).
3. Select ScenarioManager on the prefab (or your scene root).

​

ScenarioManager (in scene)

​

3. Create activities in the scene

1. Create a GameObject (e.g. under an Activities parent).
2. Add ScenarioActivity — Unity adds SequenceController automatically ([RequireComponent]).
3. Set Activity Id on ScenarioActivity to the same string as that row’s ScenarioActivityData.RefId. At runtime, the component resolves ActivityData with FirstOrDefault(a => a.RefId == activityId); a mismatch logs a warning and breaks Home/session metadata binding.
4. Configure autoAdvanceToNext if you want automatic progression to the next activity when the sequence completes.
5. Drag each activity GameObject into ScenarioManager.Activities in the intended order (unless you rely entirely on simultaneous start — then order still matters for UI/progression).

​

4. Add steps under each activity

1. Under each activity object, add child GameObjects and attach Step components (Grab, Valve, etc.).
2. SequenceController discovers Step children and runs them in hierarchy order; use ParallelStep or bridges when you need non-linear flow.
3. Wire SceneObjectReference / interactables: put ReferenceableComponent on targets and point steps at those Ref Ids.
4. Optional: Auxiliaries on each step (scoring, haptics, controller hints — VR step auxiliaries).

​

5. Scoring (optional)

1. ScenarioScoring on the ScenarioManager object (or as your prefab dictates).
2. ActivityScoring per ScenarioActivity.
3. StepScoringAuxiliary on steps that contribute points.

​

6. Register in ScenarioDataConfig

1. Open the ScenarioDataConfig SettingModule.
2. Under Scenario Collections, add or extend a collection.
3. Add your SimulationScenarioData asset to the list so Home UI can list it (and so org/content flows can resolve it when connected).

​

7. Test

​

Scene loading details

​

SceneLoadPlan structure

​

SceneEntry fields

​

Load order example

singlePlayerPlan:
  preloadScenes:
    [0] sceneName: "Environment_Factory"
        waitForRefIds: ["factory_floor", "control_panel"]
    [1] sceneName: "Lighting_Day"
        waitForRefIds: []
  scenarioScene:
    sceneName: "Scenario_SafetyTraining"

1. Load “Environment_Factory” as Single (active scene)
2. Wait for “factory_floor” and “control_panel” RefIds (or 15s timeout)
3. Load “Lighting_Day” as Additive
4. Wait two frames (no RefIds specified)
5. Load “Scenario_SafetyTraining” as Additive

​

Multiplayer role scenes

roleSceneMappings:
  [0] roleId: "operator"
      plan:
        preloadScenes: [shared environment]
        scenarioScene: "Operator_View"
  [1] roleId: "supervisor"
      plan:
        preloadScenes: [shared environment]
        scenarioScene: "Supervisor_View"

​

Tour variant (short path)

1. Create TourScenarioData (Create → MolcaSDK → Scenario → Tour Scenario Data).
2. Fill metadata, spots, materials, and scene reference like the simulation asset.
3. Open the tour scene; use [VR Tour] from Assets/_MolcaSDK/_VR/Prefabs/Tour/ or [VR Scenario] with TourScenarioData assigned — mode driver selects tour behavior.
4. Place TourAreaManager, TourSpotController, etc., per your content (Tour area and spots).
5. Runtime prefab must include TourSubsystem when using tour + session flows.
6. Register the asset in ScenarioDataConfig as above.

​

Unity Editor