- Docs
- Contribute
How it is built
For people who work on the SDK itself. The repository is private; this page is what a new team member reads first.
packages/
sdk-core session, frame loop, camera, anchors, trackers registry, overlay, .txr format (no Three.js, no A-Frame)
sdk-three Three.js stage, attach(anchor, object), loadScene
sdk-aframe A-Frame components: tempusxr, tempusxr-image-target, tempusxr-scene, tempusxr-capture
sdk-capture photo and video capture
sdk-tracker-image the MindAR fork behind the tracker contract
sdk-tracker-world WebXR floor and wall tracking
scene scene file schema, validation, migrations
target-compiler images to .txr, in a browser
apps/viewer the web Viewer
tools/ docs and site builders, release scripts
examples/ one folder per example; examples/library.json feeds the Library
The rules that shape the code:
- One adapter package per engine.
sdk-coreimports no tracking engine and no 3D library. Three.js is imported only insdk-three(and the apps); A-Frame only insdk-aframe. Both are peer dependencies, never bundled. - Contracts first.
CameraProvider,TrackerAdapter,Anchor, the public API and the scene format change only after a short proposal and an update toROADMAP.mdsection 1. The scene format is versioned and every change comes with a migration. - Matrices are 4x4, column major,
Float32Array, world space, meters (the same asMatrix4.fromArrayin Three.js). - No allocation in the frame loop. Trackers load lazily.
- Licenses. Only MIT, Apache 2.0, BSD, ISC, Zlib or CC0 dependencies, each listed in
NOTICE.md. Never GPL, AGPL or non commercial code. - TypeScript strict, no
anyin public types.
Write a new tracker: implement TrackerAdapter (see packages/sdk-core/src/contracts/tracker.ts: load, start, stop, dispose, anchors, events), extend TrackerBase, and register it with trackers.register('face', factory). Then session.use('face', options) works, in A-Frame, Three.js and scene files.