Extending & Developing

Use the development resources below for detailed guides and API references.

realvirtual scripting and behaviors

realvirtual can be extended with TypeScript behaviors, viewer integrations, and project-specific UI. Start with the open-source realvirtual repository to inspect the current code and extension patterns. Dedicated scripting guides will be added to this documentation as those public APIs mature.

See document references for how a document identifies its code, gateway configuration and knowledge file. The page also explains the trust prompt shown before project code runs.

Open Digital Twin Format

Read the rv-ODT specification when building tools that read, validate, or write self-describing industrial digital twins. The synchronized documentation links to the canonical schema, license, and conformance suite.

Unity framework development

Use the realvirtual developer documentation for Unity framework lifecycle, important classes and interfaces, assembly definitions, and testing guidance. These topics remain in the Unity documentation so there is one maintained source.

C# API reference

Open the realvirtual C# API reference for generated namespace, class, method, and property documentation.

Open source (AGPL)

The realvirtual viewer core is available under the AGPL-3.0 license in the game4automation/realvirtual-WEB repository. Use it to evaluate the viewer, build open-source extensions, or contribute improvements.

Commercial source access

Commercial customers get the source on git.realvirtual.io in one of two ways. Standard customers receive read access to the shared commercial source repository. Development customers receive a private project repository containing their project and the commercial components. Contact realvirtual to request access; the setup details arrive by email. Getting started as a commercial customer walks you through the first steps.