JSAR is a revolutionary browser engine library designed for the next computing era (Metaverse). It enables you to create immersive Web contents using the modern Web technologies (HTML5, CSS3, TypeScript) and seamlessly integrate them into mainstream 3D engines like Unity, UnrealEngine, and RealityKit.
- 🎯 3D-First Design - Unlike traditional browsers, JSAR is optimized from the ground up for 3D and spatial computing
- 🔧 Easy Integration - Supports multiple rendering backends and platform integrations
- 📱 Cross-Platform Compatible - Supports both Android and macOS platforms
- ⚡ High Performance - A builtin ECS to achieve the GPU-driven renderer for elements
- 🌐 Web Standards Compliant - Supports WebXR, WebGL, Web APIs, and other modern Web standards
Like the classic Web browser, it supports not only the HTML document, but also lots of formats, such as PDF, SVG, etc. The following formats JSAR is expected to support:
| Format | Status | Recommended Use Case |
|---|---|---|
| HTML | Partially | Browsing classic Web pages |
| Not started | Reading PDF documents | |
| SVG | Not started | Displaying SVG images |
| GLTF | Ok | Displaying 3D models |
| JPEG/PNG | Ok | Viewing images |
| XSML | Deprecated | Using WebXR applications |
XSML: namely eXtensible Spatial Markup Language, is a new format that is designed for spatial applications for HTML developers but deprecated.
| API | Status | Test Suite |
|---|---|---|
| JavaScript | Ok | - |
| TypeScript | Ok | - |
| ECMAScript Module | Ok | - |
| WebAssembly | Ok | - |
| Web Worker | Ok | - |
The following are supported renderer backends:
| Backend | OS | Status | Test Suite |
|---|---|---|---|
| OpenGLES3 | Android | Ok | - |
| OpenGL | macOS | Partially | - |
| Metal | macOS | Not started | - |
| D3D11 | Windows | Not started | - |
| API | Status | Test Suite |
|---|---|---|
| Spaces and Reference Spaces | Ok | - |
| Stereo Rendering | Ok | - |
| Inputs and Input Sources | Ok | - |
| Input Source | Status | Target Ray Mode | Gamepad | Profiles |
|---|---|---|---|---|
| gaze | Ok | gaze | No | - |
| hand(2) | Ok | tracked-pointer | No | - |
| main controller | Ok | tracked-pointer/screen | Yes | - |
| transient | Not implemented | transient-pointer | No | - |
Note: Gamepad is not supported in the current version.
| Feature | Status | Test Suite |
|---|---|---|
| Hit Test | Not implemented | - |
| Anchors | Not implemented | - |
| Hand Tracking | Ok | - |
| Eye Tracking | Not implemented | - |
| Depth Sensing | Not implemented | - |
| Face Tracking | Not implemented | - |
| Body Tracking | Not implemented | - |
| Environment Probes | Not implemented | - |
| Light Estimation | Not implemented | - |
In Web multimedia, there are the following APIs that JSAR would support:
- Playback: play audio and video, and use Web Audio API to create audio effects.
- Capture: capture audio and video from the device.
| API | Status | Test Suite |
|---|---|---|
HTMLAudioElement |
Ok | - |
HTMLVideoElement |
Not started | - |
| Web Audio API | Not started | - |
| API | Status | Test Suite |
|---|---|---|
MediaDevices |
Not started | - |
MediaRecorder |
Not started | - |
| API | Status | Test Suite |
|---|---|---|
RenderingContext2D |
Ok | - |
PDFRenderingContext |
Not started | - |
HTMLRenderingContext |
Not started | - |
Note:
PDFRenderingContextandHTMLRenderingContextare introduced by JSAR, which is used to customize the PDF and HTML rendering.
| API | Status | Test Suite |
|---|---|---|
| DOM API | Partially | - |
| HTML5 | Partially | - |
| CSS3 | Partially | - |
| Web Component | Not started | - |
To contribute to the project, you need to follow the steps below to build this project from source.
And you need to add the following targets to your Rust toolchain by your need:
$ rustup target add aarch64-linux-android
$ rustup target add aarch64-apple-darwin
$ rustup target add x86_64-apple-darwin
$ rustup target add x86_64-pc-windows-msvcFirstly, you need to install the dependencies and build the JSAR JavaScript bundle which is used in the runtime.
$ npm install && make jsbundleThen you can build the runtime library:
$ make darwin # for macOS universal library
$ make android # for Android-aarch64 libraryIf you want to do a clean build, you can run:
$ make darwin CLEAN=yesSupported parameters:
CLEAN: Clean the build directory before building.RELEASE: Build the release version of the library.INSPECTOR: Enable the inspector.
The loaders are more convenient way to integrate JSAR into your applications, the following loaders are planned to be developed:
| Loader | Status | Description |
|---|---|---|
| jsar-loader-unity | Ok | Integrates JSAR into Unity applications |
| jsar-loader-unreal | Not started | Integrates JSAR into Unreal Engine applications |
| jsar-loader-visionos | Not started | Integrates JSAR into visionOS applications |
To develop a new loader, you could see the Embedder API Documentation for more details.