Skip to content

Home

Jump to bottom
Marko Kazimirovic edited this page May 22, 2026 · 4 revisions

Augmented Insanity Wiki

Augmented Insanity is a fork of Monado that adds a service-side module system. Modules are .augins zip packages dropped into the runtime APK's modules dir; the runtime discovers them at start, validates them, calls their lifecycle hooks, and routes selected OpenXR IPC calls through them via hand-written adapters.

This wiki is the developer-facing documentation. For a user-facing "install the APK and run an OpenXR app" walkthrough, see the repo README.

Status: v0.2 [WIP]. The runtime, module loader, dispatch chain, and the ARCore head-pose module are working. Pages marked [WIP] or [Planned] document subsystems that do not yet exist or are incomplete.

Index

Concepts

  • Architecture-Overview -- client process, service process, where modules live, how a call flows from xrLocateViews to a module function.
  • Module-System -- lifecycle hooks, dispatch ordering (Q1 through Q5), .augins package format, what the loader does at start.
  • Service-Side-Dispatch -- the proto.py codegen and hand-written adapter pattern that route IPC calls into modules.

Reference

  • Manifest-Schema -- metadata.json field by field, with examples from the bundled ARCore module.
  • Host-API-Reference -- the aug_host_api v1 table modules receive in aug_on_module_load. Source of truth is src/xrt/augins/module_abi.h.

Building

  • Building-The-Runtime -- prerequisites, Android Studio config, gradlew assembleOutOfProcessDebug, install to device via adb.
  • Building-A-Module -- standalone NDK CMake build of a .augins module, packaging task, push to device.
  • Module-Example-Walkthrough -- annotated read-through of module-example/augins-head-sway/, the head-sway tutorial module.

Modules

Project status

  • Implementation-Status -- single source of truth: what works, what is [WIP], what is [Planned], what is [Broken].
  • Known-Issues -- bugs and limitations I have observed but not yet fixed.
  • Roadmap -- planned v0.2.x and v0.3+ work.

Credits

  • Acknowledgements -- upstream projects, vendored libraries, and authors this fork depends on.

Wiki source is checked into the repo under docs/wiki/. The GitHub Wiki mirrors those files.

Clone this wiki locally