Skip to main content

Manifest API

This page details the API of the manifest, which allows you to provide further details about the XRPackage.

Example manifest.json:

{
  "name": "physicscube",
  "description": "Physics Cube XRPackage",
  "start_url": "index.js"
}

name​

Defines the name of the package.

Format: a string

description​

Defines the description for the package.

Format: a string

start_url​

Defines the entry point for the package.

Format: a string, the path to the asset (gltf, glb, vrm, vox) or the website (html, js)

physics​

Defines if physic meshes should be automatically generated for the package.

Format: a boolean

physics_url​

Defines the physics .bin file for the package.

Format: a string that is the filename of the physics .bin which can be generated for .glb models here.

dynamic​

Objects (pickupable by the user) are the only ones that are autoscaled by default to 4m (Fortnite rules)

Format: a boolean

autoScale​

Parameter allows the author to disable auto scale even on dynamic objects

Format: a boolean