ORamaVR
master
master
v
0.0.0
Creator SDK
Authoring and runtime SDK for XR medical-training simulations.
Info
Context
Container
Components
Flows
Dependencies
Editor Tooling
Runtime SDK
Overview
JARIA
SceneGraph
Interaction
Device Manager
User Authentication
Recorder
Mesh deformations
Networking
GA
Analytics
Maximize
Component View: Creator SDK - Runtime SDK
Modules that make up Creator SDK's Runtime SDK.
Creator SDK
[Software System]
Runtime SDK
[Container: Unity / C# (.NET) — Runtime asmdefs from core, experimental, and omen packages]
Core
Extra
Geometric
Algebra
[Component:
C#
—
GA
asmdef:
PGA/PgaMotor
+
CGA/{R410,
CgaSpatialMath}]
Geometric-algebra
math
core:
PGA
motors
for
rigid-transform
interpolation
and
CGA
(R4,1)
multivectors
for
spatial
queries.
Hub
[Component:
C#
—
MAGES.Hub.Runtime]
Wires
modules
together
and
drives
their
lifecycle.
JARIA
Client
[Component:
C#
—
MAGES.JARIA.Runtime]
Sends
conversation
turns
to
the
JARIA
language
model.
Speech
Backend
[Component:
C#
—
MAGES.Experimental.EmbodimentJARIA.MicrosoftCognitiveServices.Runtime]
Pluggable
speech-to-text
and
text-to-speech
provider.
Microphone
[Component:
C#
—
MAGES.Hub.{Web,NonWeb}Microphone]
Provides
the
audio
input
stream;
build
target
selects
an
implementation.
Character
Controller
[Component:
C#
—
MAGES.CharacterController.Runtime]
Drives
avatar
body
and
head
animation.
Generic
IK
[Component:
C#
—
MAGES.GenericIK.Runtime]
Solves
inverse
kinematics
for
procedural
avatar
posing.
Mesh
Deformations
[Component:
C#
—
MAGES.MeshDeformations.Runtime]
Soft-body
deformation
and
cutting
for
tissue
simulation.
Experimental
SceneGraph
[Component:
C#
—
MAGES.Experimental.SceneGraph.Runtime]
Extends
SceneGraph
with
extra
action
types
and
effects
(Place
/
Hold
/
Click
/
Impact
/
Delay).
Analytics
[Component:
C#
—
MAGES.Analytics.Runtime]
Captures
training
performance
metrics
for
review
and
grading.
Data
Container
[Component:
C#
—
MAGES.DataContainer.Runtime]
Shared
session-scoped
storage
for
cross-module
data.
SceneGraph
[Component:
C#
—
MAGES.SceneGraph.Runtime]
Runs
the
authored
procedural
simulation
and
broadcasts
action
progress.
Interaction
[Component:
C#
—
MAGES.Interaction.Runtime]
Turns
hand
and
controller
manipulations
into
simulation
events.
Device
Manager
[Component:
C#
—
MAGES.DeviceManager.Runtime
+
drivers]
Abstracts
the
input
device
so
other
modules
remain
platform-agnostic.
Networking
[Component:
C#
—
MAGES.Networking.Runtime]
Synchronises
simulation
state
across
multiplayer
participants.
Localization
[Component:
C#
—
MAGES.Localization.Runtime]
Localises
action
text
and
UI
strings.
Collision
Sound
[Component:
C#
—
MAGES.CollisionSound.Runtime]
Plays
contextual
sound
effects
when
objects
collide.
Recorder
[Component:
C#
—
MAGES.Recorder.Runtime
+
optional
capture
asmdefs]
Captures
full
session
playback
for
later
review.
UI
[Component:
C#
—
MAGES.UIs]
In-headset
menus,
notifications,
and
license
prompts.
JARIA
[Component:
C#
—
MAGES.Experimental.EmbodimentJARIA.Runtime]
Drives
in-scene
AI
characters:
listens,
consults
the
LM,
speaks
the
response.
GenAI
Module
[Component:
C#
—
MAGES.GenerativeAI.Runtime]
Runtime
configuration
for
OMEN's
generative-AI
services.
Trainee
Performs
a
medical-training
scenario
in
the
simulator.
ORamaVR
Cloud
[Software
System]
ORamaVR's
hosted
backend:
identity
at
login.oramavr.com,
AI
agent
platform
at
api.oramavr.com,
content
portal
at
portal.oramavr.com,
and
analytics
at
analytics.api.oramavr.com.
Azure
Speech
[Software
System]
Cloud
speech-to-text
and
text-to-speech.
Photon
Cloud
[Software
System]
Hosted
relay
for
multiplayer
state
synchronisation.
Unity
XR
Plugins
[Software
System]
OpenXR,
Oculus
XR,
XR
Management,
Input
System,
and
AR
Foundation
—
headset,
controller,
and
hand-input
backends.
Unity
DOTS
Stack
[Software
System]
Burst
compiler,
Job
System,
Collections,
and
Mathematics
—
high-performance
compute
used
by
the
XPBD
soft-body
solver.
Dissonance
VoIP
[Software
System]
In-session
voice-chat
asset;
its
audio
is
captured
into
session
recordings.
CharacterController → SceneGraph — Contributes SetCharacterControllerStep
Contributes SetCharacterControllerStep
MeshDeformations → SceneGraph — Contributes Suturing ActionData + effect
Contributes Suturing ActionData + effect
ExperimentalSceneGraph → SceneGraph — Contributes ActionData + effect implementors
Contributes ActionData + effect implementors
ExperimentalSceneGraph → Interaction — Queries grabbable / hand state
Queries grabbable / hand state
ExperimentalSceneGraph → DeviceManager — Queries camera height
Queries camera height
JARIA → GeometricAlgebra — Computes user-relative spatial context (CGA points / planes)
Computes user-relative spatial context (CGA points / planes)
JARIA → JARIAClient — Sends EmbodiedAIRequest / JariaRequest
Sends EmbodiedAIRequest / JariaRequest
JARIA → SpeechBackend — STT/TTS via speech handler interfaces
STT/TTS via speech handler interfaces
JARIA → Microphone — Captures the microphone audio stream
Captures the microphone audio stream
Trainee → JARIA — Speaks; receives voice + subtitles + animations
Speaks; receives voice + subtitles + animations
JARIAClient → ORamaVRCloud — Sends conversation turns [HTTPS / JSON]
Sends conversation turns
[HTTPS / JSON]
JARIA → ORamaVRCloud — Reads tenant token budget [HTTPS / JSON]
Reads tenant token budget
[HTTPS / JSON]
Recorder → ORamaVRCloud — Uploads session recordings [HTTPS]
Uploads session recordings
[HTTPS]
SpeechBackend → AzureSpeech — Speech-to-text + text-to-speech [Azure Speech SDK]
Speech-to-text + text-to-speech
[Azure Speech SDK]
Networking → PhotonCloud — Joins rooms; relays state + events [Photon PUN / UDP]
Joins rooms; relays state + events
[Photon PUN / UDP]
DeviceManager → UnityXRPlugins — Reads headset / controller / hand input through the XR driver layer [Unity.XR.Management + Unity.InputSystem]
Reads headset / controller / hand input through the XR driver layer
[Unity.XR.Management + Unity.InputSystem]
Recorder → DissonanceVoIP — Captures in-session voice chat into recordings [Dissonance Voip capture asmdef]
Captures in-session voice chat into recordings
[Dissonance Voip capture asmdef]
Hub → SceneGraph — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Interaction — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → DeviceManager — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Networking — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Analytics — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → DataContainer — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → JARIA — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Localization — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → CollisionSound — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Recorder — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → UI — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → GenAIModule — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Component View: Creator SDK - Runtime SDK
Modules that make up Creator SDK's Runtime SDK.
Legend
User card
Software system
External
Core module
AI module
Extra module
Experimental
Relationship
Component View: Creator SDK - Runtime SDK
Modules that make up Creator SDK's Runtime SDK.
Creator SDK
[Software System]
Runtime SDK
[Container: Unity / C# (.NET) — Runtime asmdefs from core, experimental, and omen packages]
Core
Extra
Geometric
Algebra
[Component:
C#
—
GA
asmdef:
PGA/PgaMotor
+
CGA/{R410,
CgaSpatialMath}]
Geometric-algebra
math
core:
PGA
motors
for
rigid-transform
interpolation
and
CGA
(R4,1)
multivectors
for
spatial
queries.
Hub
[Component:
C#
—
MAGES.Hub.Runtime]
Wires
modules
together
and
drives
their
lifecycle.
JARIA
Client
[Component:
C#
—
MAGES.JARIA.Runtime]
Sends
conversation
turns
to
the
JARIA
language
model.
Speech
Backend
[Component:
C#
—
MAGES.Experimental.EmbodimentJARIA.MicrosoftCognitiveServices.Runtime]
Pluggable
speech-to-text
and
text-to-speech
provider.
Microphone
[Component:
C#
—
MAGES.Hub.{Web,NonWeb}Microphone]
Provides
the
audio
input
stream;
build
target
selects
an
implementation.
Character
Controller
[Component:
C#
—
MAGES.CharacterController.Runtime]
Drives
avatar
body
and
head
animation.
Generic
IK
[Component:
C#
—
MAGES.GenericIK.Runtime]
Solves
inverse
kinematics
for
procedural
avatar
posing.
Mesh
Deformations
[Component:
C#
—
MAGES.MeshDeformations.Runtime]
Soft-body
deformation
and
cutting
for
tissue
simulation.
Experimental
SceneGraph
[Component:
C#
—
MAGES.Experimental.SceneGraph.Runtime]
Extends
SceneGraph
with
extra
action
types
and
effects
(Place
/
Hold
/
Click
/
Impact
/
Delay).
Analytics
[Component:
C#
—
MAGES.Analytics.Runtime]
Captures
training
performance
metrics
for
review
and
grading.
Data
Container
[Component:
C#
—
MAGES.DataContainer.Runtime]
Shared
session-scoped
storage
for
cross-module
data.
SceneGraph
[Component:
C#
—
MAGES.SceneGraph.Runtime]
Runs
the
authored
procedural
simulation
and
broadcasts
action
progress.
Interaction
[Component:
C#
—
MAGES.Interaction.Runtime]
Turns
hand
and
controller
manipulations
into
simulation
events.
Device
Manager
[Component:
C#
—
MAGES.DeviceManager.Runtime
+
drivers]
Abstracts
the
input
device
so
other
modules
remain
platform-agnostic.
Networking
[Component:
C#
—
MAGES.Networking.Runtime]
Synchronises
simulation
state
across
multiplayer
participants.
Localization
[Component:
C#
—
MAGES.Localization.Runtime]
Localises
action
text
and
UI
strings.
Collision
Sound
[Component:
C#
—
MAGES.CollisionSound.Runtime]
Plays
contextual
sound
effects
when
objects
collide.
Recorder
[Component:
C#
—
MAGES.Recorder.Runtime
+
optional
capture
asmdefs]
Captures
full
session
playback
for
later
review.
UI
[Component:
C#
—
MAGES.UIs]
In-headset
menus,
notifications,
and
license
prompts.
JARIA
[Component:
C#
—
MAGES.Experimental.EmbodimentJARIA.Runtime]
Drives
in-scene
AI
characters:
listens,
consults
the
LM,
speaks
the
response.
GenAI
Module
[Component:
C#
—
MAGES.GenerativeAI.Runtime]
Runtime
configuration
for
OMEN's
generative-AI
services.
Trainee
Performs
a
medical-training
scenario
in
the
simulator.
ORamaVR
Cloud
[Software
System]
ORamaVR's
hosted
backend:
identity
at
login.oramavr.com,
AI
agent
platform
at
api.oramavr.com,
content
portal
at
portal.oramavr.com,
and
analytics
at
analytics.api.oramavr.com.
Azure
Speech
[Software
System]
Cloud
speech-to-text
and
text-to-speech.
Photon
Cloud
[Software
System]
Hosted
relay
for
multiplayer
state
synchronisation.
Unity
XR
Plugins
[Software
System]
OpenXR,
Oculus
XR,
XR
Management,
Input
System,
and
AR
Foundation
—
headset,
controller,
and
hand-input
backends.
Unity
DOTS
Stack
[Software
System]
Burst
compiler,
Job
System,
Collections,
and
Mathematics
—
high-performance
compute
used
by
the
XPBD
soft-body
solver.
Dissonance
VoIP
[Software
System]
In-session
voice-chat
asset;
its
audio
is
captured
into
session
recordings.
CharacterController → SceneGraph — Contributes SetCharacterControllerStep
Contributes SetCharacterControllerStep
MeshDeformations → SceneGraph — Contributes Suturing ActionData + effect
Contributes Suturing ActionData + effect
ExperimentalSceneGraph → SceneGraph — Contributes ActionData + effect implementors
Contributes ActionData + effect implementors
ExperimentalSceneGraph → Interaction — Queries grabbable / hand state
Queries grabbable / hand state
ExperimentalSceneGraph → DeviceManager — Queries camera height
Queries camera height
JARIA → GeometricAlgebra — Computes user-relative spatial context (CGA points / planes)
Computes user-relative spatial context (CGA points / planes)
JARIA → JARIAClient — Sends EmbodiedAIRequest / JariaRequest
Sends EmbodiedAIRequest / JariaRequest
JARIA → SpeechBackend — STT/TTS via speech handler interfaces
STT/TTS via speech handler interfaces
JARIA → Microphone — Captures the microphone audio stream
Captures the microphone audio stream
Trainee → JARIA — Speaks; receives voice + subtitles + animations
Speaks; receives voice + subtitles + animations
JARIAClient → ORamaVRCloud — Sends conversation turns [HTTPS / JSON]
Sends conversation turns
[HTTPS / JSON]
JARIA → ORamaVRCloud — Reads tenant token budget [HTTPS / JSON]
Reads tenant token budget
[HTTPS / JSON]
Recorder → ORamaVRCloud — Uploads session recordings [HTTPS]
Uploads session recordings
[HTTPS]
SpeechBackend → AzureSpeech — Speech-to-text + text-to-speech [Azure Speech SDK]
Speech-to-text + text-to-speech
[Azure Speech SDK]
Networking → PhotonCloud — Joins rooms; relays state + events [Photon PUN / UDP]
Joins rooms; relays state + events
[Photon PUN / UDP]
DeviceManager → UnityXRPlugins — Reads headset / controller / hand input through the XR driver layer [Unity.XR.Management + Unity.InputSystem]
Reads headset / controller / hand input through the XR driver layer
[Unity.XR.Management + Unity.InputSystem]
Recorder → DissonanceVoIP — Captures in-session voice chat into recordings [Dissonance Voip capture asmdef]
Captures in-session voice chat into recordings
[Dissonance Voip capture asmdef]
Hub → SceneGraph — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Interaction — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → DeviceManager — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Networking — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Analytics — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → DataContainer — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → JARIA — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Localization — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → CollisionSound — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → Recorder — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → UI — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Hub → GenAIModule — Owns + ticks the module lifecycle
Owns + ticks the module lifecycle
Component View: Creator SDK - Runtime SDK [
svg
|
png
|
puml
]