·
avatar · drop-in viewer
What it does
No description provided yet.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
This asset doesn't declare a schema or structured payload.
Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Showing up to 3 levels deep. Open a part to see what it holds further down.
60+items
# avatar
A playable character, composed from three **independent** parts:
- **body** (optional): a `.bundle` (a skinned `.mesh` + bone entities, a character
imported from a GLB/FBX) or a plain `.mesh`. The look. An avatar with no body is
a controller or first-person camera with no visible mesh.
- **controller** — the movement system. Default: the standard humanoid kit
(`CharacterController` + `MovementState` + `Humanoid`).
- **animation** — the system that animates the body. Default: the shared
`Locomotion` blend space (reads the controller's velocity, plays retargeted
clips). Or `ClipPlayer`. Or your own component.
Movement and animation are **not** tied together — attaching the controller never
pulls in `Locomotion`, and choosing your own `animation` keeps the standard
controller. Authoring your own locomotion is a one-field swap (`animation = ...`).
Because the standard clip set retargets onto **any** humanoid rig, the default
locomotion drives any humanoid body with no per-body setup and no editing of any
built-in content.
## Make an imported character playable
```luau
-- After importing a rigged humanoid GLB, the importer leaves a `.bundle`
-- (skinned mesh + bones). Survey for it, then wrap it in an avatar:
local body = asset.resolve("my_character", "bundle")
local hero = asset.create("avatar", "my_hero", { body = body })
```
To make `hero` the body every connecting player spawns with, point the scene's
`PlayerPrototype.body` at a body entity whose `Asset` source is `hero` (authored
in the scene tree — see `man scene`). To drive the **local** player with it right
now, instantiate it and bind the entity:
```luau
local root = hero:instantiate() -- spawns the body + movement kit
layers.active.players.localPlayer.avatar = root -- bind the live body
```
Only the avatar bound as the local player's body answers the player's
controls. Every other avatar you instantiate (an NPC, a mannequin, a preview)
stands where it is until something drives it: with the standard controller,
write its `CharacterController` input bus (`inputX` / `inputZ` / `inputJump`)
from a component of your own, the way an AI brain does (`man CharacterController`).
```luau
local npc = hero:instantiate() -- stands still
npc.component.get("CharacterController").inputZ = -2 -- walks while this is written each frame
```
An avatar is **not** humanoid-only. The body can be anything — a humanoid, a
vehicle, an unrigged plane with a custom controller and shader. The defaults
adapt to the body: a **humanoid** body defaults to the shared humanoid Locomotion
(the `synty` clip preset); a **non-humanoid / unrigged** body gets **no
auto-animation** (you supply your own `controller` and `animation`). This is the
non-humanoid detection — an arbitrary animated model is never auto-driven by
humanoid locomotion — and it never blocks creating the avatar.
```luau
-- Non-humanoid avatar (e.g. a custom-controlled body), fully generic:
asset.create("avatar", "ship", { body = shipBundle, controller = { system = "ShipController" }, animation = false })
```
## Options
`asset.create("avatar", name, opts)`:
| opt | meaning |
|-----|---------|
| `body` (optional) | the body `.bundle` or `.mesh` ref; omit for a body-less avatar |
| `controller` | movement: `true`/nil = standard kit, `false` = none, or a component name / `{ system, data }` |
| `animation` | a component name or `{ system, ... }` — **author your own locomotion here**; defaults to Locomotion |
| `locomotion` | clip preset for the default Locomotion (default `"synty"`) |
| `clip` | a single `.animation` ref — selects a one-clip `ClipPlayer` |
| `looping` / `speed` / `sourceRig` | `ClipPlayer` tuning (with `clip`) |
| `expressions` | the blend shape each standard expression preset plays, where the body's shapes are not named after the presets: `{ aa = "Mouth_A", blink = { shape = "Eyes_Closed", overrideMouth = "block" } }` |
| `parameters` / `animator` / `menu` / `parts` | the avatar's parameters, its animator, its expression menu and its own parts seated on its body (below) |
| `type` | the avatar type its body is mapped onto (an `avatarType` ref or identity); the builtin humanoid when omitted |
Author your own locomotion (keeps the standard movement):
```luau
asset.create("avatar", "my_hero", { body = body, animation = { system = "MyLocomotion" } })
```
`avatar.json`:
```json
{
"body": { "__ref": "<bundle guid>" },
"controller": true,
"animation": { "system": "Locomotion", "preset": "synty" }
}
```
The body's facing is read from its rig (the importer records a `forward` for each
body — `{0,0,1}` for a +Z Synty/FBX body, `{0,0,-1}` for a -Z glTF body), so
Locomotion turns the body to its movement direction regardless of how its source
authored it. No per-avatar facing knob.
## Use
```luau
local root = avatarRef:instantiate() -- spawn body + movement kit
avatarRef:setCharacter(root, asset.resolve("knight", "bundle")) -- swap the body, keep the behaviour
```
`:instantiate()` spawns the body and attaches the movement system bound to it.
`:setCharacter(root, body)` despawns the current body and spawns a new one in its
place; the Locomotion kit on the avatar root re-resolves the new body's rig, so
the look swaps while the behaviour is kept. Items seated with
`Humanoid:attach` are kept: each moves to the new body's socket for the same
point, with the transform it was seated with. An item whose point the new body
lacks stays on the avatar root and is seated by the next swap to a body that
has it. The new body takes the old body's id and is composed with the options
the avatar was instantiated with, and the avatar's `Asset` id map names it.
## The avatar standard
A humanoid avatar is built around one standard (the `avatarStandard` module):
the VRM 1.0 bones, 19 attachment points, the viewpoint, the face expressions and
a height band. A game relies on it to seat its own items on any visitor's body
(`Humanoid:attach("rightGrip", sword.id)`) and to read where the eyes are.
```luau
local d = avatarRef:descriptor() -- bones, points, viewpoint, expressions, height
print(d.height, d.points.hat.position.y, d.viewpoint.source)
local v = avatarRef:validate() -- { ok, problems }
for _, p in v.problems do print(p.rule, p.name, p.message) end
```
`:validate()` names every rule the body breaks, one problem per missing item: a
required bone (`rightHand`), an attachment point the body cannot carry
(`rightGrip`), a face expression no blend shape answers (`aa`), a height outside
the band, or a body that is not a humanoid at all. A game holds bodies to the
rules it relies on: `avatarRef:validate({ rules = { "type", "bone", "point", "height" } })`
leaves out the face expressions. A live avatar answers the same through its
`Humanoid` (`:descriptor()`, `:validate(opts)`).
## Parameters, an animator and an expression menu
An avatar declares its own state as data: `parameters` (named bools, ints and floats,
synced or local, saved or not, the synced ones 256 bits in all), an `animator` (layers of
state machines over the parameters, whose states pose blend shapes and bones, show and
hide parts, set shader data and play `.animation` clips on the body under the layer's
mask, a wave on the right arm or a dance over the locomotion), a `menu` (buttons, toggles, sub-menus, radial and
two-axis puppets) the person uses from the app menu's **Expressions** tab, and `parts`
(meshes seated on its body's attachment points on every peer). No script is
involved, and every peer draws the same avatar from the parameters it receives.
```luau
local hero = asset.create("avatar", "my_hero", {
body = body,
parts = { { name = "Hat", mesh = "@builtin::meshes.cone", point = "hat", scale = 0.25 } },
parameters = { { name = "Hat", type = "bool", default = true, saved = true } },
animator = { layers = { {
name = "Hat",
states = { { name = "On" }, { name = "Off", motion = { hide = { "Hat" } } } },
transitions = { { from = "On", to = "Off", when = "!Hat", duration = 0 },
{ from = "Off", to = "On", when = "Hat", duration = 0 } },
} } },
menu = { { type = "toggle", label = "Hat", parameter = "Hat" } },
})
local check = hero:animator() -- { ok, problems, summary, syncedBits, cost }
```
`hide = { "Hat" }` names the part the avatar declares; any entity under the avatar is named
the same way, and an attachment point's name (`hat`) names every item seated there. An avatar whose synced parameters pass 256 bits is refused when it
is created, with the overrun stated. The `avatarAnimator` module's README has the whole data
form, and the `AvatarAnimator` component runs it.
## In the Inspector
Selecting an avatar opens its **Avatar** section, read from `avatar.json`: its label when it has one, how it moves (`controller`: the standard mover, none, or the system it names), what animates it, and whether it is humanoid. It links the body the avatar wears, or says the avatar spawns no visible body, and offers to open `avatar.json` in the Code panel.
## The body's skeleton
`avatarRef:rig()` is the `.rig` of the body's skinned mesh (nil for a body-less avatar or a
plain mesh), and `avatarRef:avatarType()` the avatar type its body is mapped onto. The
`avatar` toolbox reads and corrects that mapping (`avatar.inspect`, `avatar.map`), and makes,
dresses and saves avatars; `guides { path: "core/avatars" }` walks through it.
▲ 0↑ born
# Locomotion
Blend-space-driven locomotion for entities running the
characterController package. Reads horizontal velocity from a sibling
`MovementState` (or, as a fallback, `CharacterController`) component
on the parent and feeds a single 2D blend space (strafe-angle on X,
speed on Y) with idle / walk-{F,L,R,B} / run-{F,L,R,B} / sprintF
clips. Each clip's point sits at the speed the clip carries this body
at: its retarget bake measures how fast the ground passes under the
stance foot on this body's legs, so the feet move with the ground at
whatever speed the body moves. A clip that plays without a measured
speed sits at its gait's `walkSpeed` / `runSpeed` / `sprintSpeed`.
Pair on the same entity (or a parent of) a `SkinnedModel`. The
component creates the AnimGraph, polls for the SkinnedModel child
once start() has run, registers the clips as blend-space points and
plays the graph. `update()` damps speed + angle and writes them to
the active blend space each frame.
This supersedes the older FSM-based Locomotion controllers
(crouch / jump / fall / land / turn-in-place state machine). Those
behaviours can be added back as separate layered graphs once the
blend-space driver has settled.
▲ 0↑ born
# synty
Locomotion speeds and the Synty Polygon Masculine clip set for the
`Locomotion` component: walk, run and sprint thresholds, an idle, and
four-direction walk and run clips plus a forward sprint.
```luau
preset.apply("synty", { entity = id, component = "Locomotion" })
```
▲ 0↑ born
# Polygon Synty Character
A low-poly rigged humanoid character (Synty POLYGON style) bundled for the
character-controller system — a ready-to-drive sample body with its skeleton,
so the controller has a real avatar to move, animate, and test against.
Decomposed from `PolygonSyntyCharacter.fbx`.
## Composition
- Root `PolygonSyntyCharacter` with the imported node hierarchy.
- Carries the skinned character mesh and its `.rig` (skeleton) as subassets.
## Usage
Referenced by the character-controller package as its default humanoid body;
spawn it and attach a controller to walk it around.
▲ 0↑ born
# assetType (asset type)
An asset type says what a kind of asset is: the files an asset of the kind is
made of, the code that gives it behaviour, the interface a person uses to work
with it, and how it is found, pictured and checked. A `<typename>.assetType/`
folder declares a type called `<typename>`, and every `<name>.<typename>/`
folder is an asset of it. `assetType` is itself a type, so a type is an asset
like any other: it is created, versioned, installed and contributed the same way.
## Making a type
`asset.create("assetType", "<typename>")` scaffolds a type. The type registers
the moment its folder is written, anywhere under `/zero/source/`, and from then
on `<name>.<typename>/` folders are its assets. An asset of a type that is not
registered yet is not an asset, so make the type first.
A type folder is a root: `~.x` in any file inside it names the type's own `x`,
wherever the type is installed. Keep the type's whole implementation inside its
folder and reach it that way.
What a type folder must hold is set by this type's own `type.yaml`, the same way
every type's `type.yaml` sets what its assets hold. `asset.validate` on a type
reports anything missing, and the scaffold produces a folder that passes.
## What sets your type's schema (`type.yaml`)
`type.yaml` is the structural contract every asset of the type is checked
against. The keys below are the ones the engine reads; a key not listed here is
ignored.
| Key | What it controls |
|---|---|
| `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. |
| `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. |
| `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. |
| `is_container` | Whether the suffix stays in the identities of what the asset holds. |
| `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. |
| `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. |
| `is_text_default` | Whether the asset's files are text unless stated otherwise. |
| `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. |
| `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. |
| `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. |
| `files: { required, optional }` | The files an asset holds (below). |
| `allow_unlisted` | `false` reports every file the type does not declare. |
| `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. |
| `settings:` | Typed per-asset settings (below). |
| `inspector:` | The interface people use for the type and its assets (below). |
| `preview:` | How an asset is pictured (below). |
| `references:` | Names of other assets the type's files carry (below). |
| `indexing:` | What search reads for each asset (below). |
| `describe:` | How a missing description is generated (below). |
### The files an asset holds
Each entry under `files.required` or `files.optional` is
`{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches
within one segment. Entries that share a `one_of_group` are satisfied by any one
of them. `content` lists checks on the file's bytes:
| Check | Passes when |
|---|---|
| `non_empty` | the file has content |
| `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape |
| `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML |
| `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") |
Each check takes a `message`, which is what the author is told when it fails.
### Settings
`settings: { values, schema: { type | instance, export? } }` gives every asset
typed settings. `values` names the file an asset's values live in; `schema.type`
declares one schema for the whole type, and `schema.instance` names a file each
asset declares its own in. `asset.create` writes the resolved values, and a write
to the values file reaches `onChange` with what changed.
## The human side (`inspector.luau`)
A type is used by people through its Inspector, and without one the type is
usable only from code. The Inspector is the type's interface for a person: for a
procedural graph it is the graph editor, for a kit it is the tracking view of
what the kit holds and what is still missing. Writing it is part of writing the
type.
`inspector: { type, instance? }` in `type.yaml` names the files. `type` is the
interface for the type itself and for its assets; `instance` names a file an
asset may ship to add its own. Each returns:
```luau
return {
sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } },
replace = { contents = { ... } }, -- replace a default section by id
order = { "graph", "contents" }, -- section order
}
```
`build(ctx)` receives the asset and builds the section. A section's `title`, and
the text its rows carry, is a string or an `i18n.text` value read from a catalog
(`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType",
...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a
type that names no inspector, or names one that does not load, reports it.
## Say what your type is for (`about.yaml`)
Every type carries an `about.yaml` that says what the type is for, in three
plain-language texts:
```yaml
intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering."
function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text."
usage: "You choose it by name for your UI or your text, and the text appears in that typeface."
```
- **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes.
- **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes.
- **`usage`** is what a person or an agent does with one. Up to 1200 bytes.
Write about the type as a whole, not one asset of it, and say what it does now.
Agents read these texts to learn when to reach for the type and how; people
searching find the type by them. The scaffold starts each text with
`[[describe]]` and a note on what to write; a text that still starts that way
counts as not written. `services describe` can write them.
They show up in `asset.inspect` as `detail.about`, in
`assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide,
and at the top of the type's Inspector.
## Ask your assets to say what they are
A type can require each asset to carry a description: a file, written by the
author or generated, saying what the asset is and what it is for. Declare it with
a `described` check:
```yaml
files:
required:
- path: "README.md"
kind: "file"
content:
- { check: "described", message: "Say what this widget is for and where it goes." }
```
A file that is missing, empty or still has a line starting with `[[describe]]`
fails the check, and so does a YAML file whose named `keys` are missing or over
their `max_bytes`, or a Markdown file missing a named heading. `asset.validate`
names the asset, and a push that carries it is refused with `message`.
`services describe` finds such assets and writes their descriptions.
`describe:` steers what is generated:
```yaml
describe:
guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI."
examples:
- "<identity of an asset of this type whose description reads well>"
```
An example is an asset of your type whose description is a true, written one,
never a placeholder and never the asset being described; with none, leave
`examples` empty. A type whose assets the model cannot perceive (a sound, a
motion) says so in `guidance`, and the description is drawn only from what the
asset's own files state.
Start the file unwritten in your `template/`: a heading and one line starting
with `[[describe]]`, never example content, which every new asset would carry
verbatim. A type whose assets say what they are through their own content (a
mesh, a texture) declares no check.
## The type's code (`behavior.luau`)
`behavior.luau` returns one table. These are the keys the engine reads from it;
anything else on the table is the type's own.
### What the type's assets can do
| Key | Shape | What the engine does with it |
|---|---|---|
| `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. |
| `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. |
| `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. |
| `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). |
| `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. |
| `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. |
Some `ref` names mean the same for every type, and the engine calls them:
- **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below).
- **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below).
- **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe.
- **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints.
- **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode.
Some names are answered for every asset before the type is asked, so a `ref`
entry of the same name is never reached: `getSource`, `getBytes`, `getText`,
`exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours
when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the
residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`,
`gpu_resident`.
### When the engine calls the type
| Hook | Signature | When it runs |
|---|---|---|
| `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. |
| `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. |
| `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. |
| `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. |
| `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. |
| `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. |
| `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. |
### Settings hooks
| Hook | When it runs |
|---|---|
| `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. |
| `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. |
| `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. |
| `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. |
| `settingsHealed(values, stored)` | On a read, to repair stored values. |
| `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. |
`creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options
that are inputs to the type rather than settings.
### Reloading
An edit to `behavior.luau` reaches existing assets with no restart.
## How an asset is pictured (`preview:`)
| `kind` | The picture is | The type provides |
|---|---|---|
| `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` |
| `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order |
| `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` |
| `custom` | whatever `ref.preview` returns | `ref.preview` |
```yaml
preview:
kind: surface
mesh: sphere
```
`angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop
and the framing, so an asset pictures the same in every world. A type with no
`preview:` that defines `instantiate` still answers `ref:preview()`.
A picture is rendered when something asks to view it (the editor showing the
asset, `ref:preview()`), when previews are generated on request
(`assets.generatePreviews`), and when the asset is staged. An edit alone
renders nothing. The picture records what it was made
from, so a stale one is told from a current one.
## The names your type's assets hold (`references:`)
Where your type's own format or API carries the name of another asset, declare
it here:
```yaml
references:
keys: # a top-level key of the type's files that holds a name, or a table of them
- { key: "shader", type: "shader" }
args: # an argument of a call, counting from 1
- { call: "g:node", position: 2, type: "procNode" }
fields: # a field of the options table a call takes
- { call: "fx.beam", field: "material", type: "material" }
```
`type` is the category the name resolves in. `asset.declareReferenceKey`,
`asset.declareReferenceArg` and `asset.declareReferenceField` declare the same
from a script.
## What search reads (`indexing:`)
`indexing:` is how assets are found. Search reaches an asset only through what
its type's `indexing:` names, and adds nothing of its own. That includes you: an
asset indexed badly is one you cannot find later, when you are making something
else and need it. A type whose assets are never looked for says `indexing: none`.
```yaml
indexing:
data: # text, read from the asset's files
- role: identity
extractor: verbatim
source: { file: "README.md" }
- role: interface
extractor: symbols
source: { files: ["init.luau"] }
- role: implementation
extractor: verbatim
source: { files: ["init.luau"] }
content: # the picture
- role: identity
modality: image
source: { file: "preview.png" }
facets: # what a query filters and re-ranks by
file: ".metadata"
rigged: { type: bool, from: { components: { contains: SkinnedModel } } }
roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } }
```
**Roles.** Each `data` and `content` entry has a `role`, and a query matches in
two slots:
- **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is.
- **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both.
Ask what a person would recognise an asset of the type by, and what it does, and
point each role at the file that says it. For text, that is the asset's
description: the file your template starts with a `[[describe]]` block, which the
author writes or `services describe` fills in (see "Ask your assets to say what
they are").
**`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds
the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`.
Never index a file name (`source: { field: name }`): one
or two words carry nothing to match.
**`content`.** `modality: image` embeds the picture itself, so a text query
matches what the asset looks like. A type whose assets are looked at makes the
picture its identity.
**`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded
whole, so keys nobody declared in it are still found. Each further key is
computed for every asset and states a value for every one, including `false`: a
file can imply "not rigged" but never say it, and a query separates rigged from
unrigged only because the unrigged ones say `rigged: false`. A key is
`{ type: bool | number | enum, filter?: range, from }`, where `from` is
`{ file, field }` (a field of one of the asset's files, dotted for nesting),
`{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the
asset's entities carry).
## What blocks a push
A push checks every asset it carries against its type. These refuse it:
- a required file that is missing, a `content` check that fails, a `described` file not written yet;
- an error from the type's `validate`.
Unlisted files and warnings do not. A `described` file blocks only a push that
changes the asset. When a push is refused, the message names each asset and what
it lacks. `world.publishBlockers()` and `zm status` read the same list without
pushing.
## Typing a result from the asset (`refShapes`)
A `ref` method whose result depends on the asset (one entry per child folder, per
row of a config, per control a map declares) can only be annotated as
`{ [string]: Thing }`, which accepts any key. `refShapes` states the result for
each asset instead: a function returning a Luau type expression for that asset,
and the module whose types the expression uses. Read the asset; never run it.
```lua
-- inputMap.assetType/behavior.luau
M.refShapes = {
activate = function(self): (string, string)
local names = {}
for _, control in ipairs(M.ref.controls(self)) do
table.insert(names, control.name .. ": Handle")
end
if #names == 0 then return "", "" end
return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme"
end,
}
```
With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported.
A per-asset type applies where the call site names which asset: a component
field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`.
`asset.resolve(name, category)` carries only the category, and a name computed
at runtime carries nothing, so calls on those keep the declared return. The type
belongs to the call's result: index it there, or bind what you need from it
there, and the names stay checked.
`require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows
what was published: `categories` (each type's method surface) and `returns`
(per-asset results by identity, then method). An identity missing from
`returns` was never published. Results are recomputed when an asset is written;
at most 64 assets of one type are read.
## Putting an asset in a scene (`ref.instantiate`)
A caller writes one piece of code against every instantiable type, so what
`instantiate` returns is fixed:
```lua
local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable")
M.ref = {
instantiate = function(self, target, opts)
local root = Instantiable.root(self, target, opts)
-- compose the asset under `root`, now
return Instantiable.result(self, root, idMap)
end,
}
```
**In.** `target` is the entity the asset lands under, or onto for a hierarchy
type; with none, the type spawns a new root. `position`, `rotation` (three
numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the
same for every type: `Instantiable.root` applies them to a root you make,
`Instantiable.place` to one you adopt. Document any options of your own in the
hook's `--!arg` docs.
**Out.** `(root, idMap)`. `root` is the composed root, live when you return:
build synchronously, never defer to a component's `awake`. `idMap` maps each
original id to the spawned one, so a component that composes the asset again on
every load can pass it back in and keep references into the composition. Every
call goes through `Instantiable.result`, which refuses a root that is not live
and turns a missing `idMap` into `{}`.
## Inspecting an asset (`ref.inspect`)
`asset.inspect(ref)` builds a record every asset shares (`identity`, `name`,
`guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`,
`description`, `tags`), then calls `ref.inspect(self)` for the type's own
`detail`:
```lua
M.ref = {
inspect = function(self)
-- read the asset's own files, never runtime state: inspect works on an asset
-- that has not been compiled, uploaded or registered
return { --[[ what makes this asset what it is ]] }
end,
}
```
Without it, the record is the shared part alone, and an agent inspecting the
asset learns nothing of what it is. A hook that raises leaves `detail` empty and
sets `record.warning`.
## Discovery
- `asset.list("assetType")`: every registered type.
- `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts.
- `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
# Component (asset type)
A component is a reusable behavior + data unit attached to an entity.
The component file declares public fields, methods, and lifecycle
callbacks; the engine instantiates one per attachment and drives its
hooks every frame. Components are the primary unit of gameplay code —
movement, AI, animations, UI panels, network sync, and per-entity state
all live here.
## When to use one
- You need per-entity state that survives across frames.
- You need per-entity behavior driven by engine lifecycle hooks
(`start`, `update`, `onDestroy`).
- You want to expose configurable fields to designers / `entity.spawn`
callers / scenes without code changes.
If you need a stateless pure-function library, use a `.module`. If you
need to generate content declaratively, use a `.service`; compute work
belongs in a `.computeShader`.
## Where it lives
- Source: `/zero/source/.../<Name>.component/`
- Identity: `<Name>` (the `.component` suffix strips from the
identity, but the folder retains the suffix on disk).
- Folder shape:
- `init.luau` (or `init.lua`) — declares the component. **Required.**
- `README.md` — instance-level documentation. **Required.**
- `.metadata` — agent-editable tags + free-form fields. **Required.**
The structural contract is enforced by `asset.validate` against this
type's `type.yaml`.
## How to create one
Always start with the scaffold — it guarantees the folder shape
matches `type.yaml` from the moment it's on disk:
```luau
asset.create("component", "<Name>")
-- Creates: /zero/source/<Name>.component/
-- init.luau (canonical declare + public block + hooks stubbed)
-- README.md (instance README template)
```
After scaffolding, edit `init.luau` to fill in the actual fields and
behaviour. The component registers as soon as the file is written —
hot-reload is automatic; no engine restart required.
## How it operates
1. **Registration.** Writing `init.luau` into a `.component/` folder
indexes the asset, mints a guid (in the `.meta` sidecar), and
surfaces the type to the engine's component registry. Same-frame
visible to `entity.component.add`.
2. **Attachment.** `entity(id).component.add(name, data)` (or the
batch form `tools.use("entityOps", "addComponents", targets,
{ [name] = data })`) attaches an instance.
The `data` table's fields override the component's declared
defaults; omitted fields take the declared default. The `data`
values are copied into `public.*` BEFORE `awake()` runs.
3. **Lifecycle.** The hooks run in this order:
- `awake()` — same frame as attach, immediately after the data
copy. Initialise state, set up native bridges, register with
other systems. Other components on the same entity may not have
awoken yet.
- `start()` — the next frame. Every component on the entity has
completed `awake()` by then, so cross-component setup is safe
here.
- `update(dt)` — same frame as `start()`, then every frame after,
for as long as the gameplay clock is running. `fixedUpdate(dt)`
runs once per physics step, straight after it, with the step's
`dt`, so a frame can run it several times or not at all;
`editorUpdate(dt)` runs
while the clock is held. Which of them ticks is decided by
`engine.mode` AND `engine.paused` together — see **Per-frame
hooks and the two axes** below, and `man modes`.
- `onDestroy()` — when the component is removed via
`component.remove` or when the owning entity is despawned.
Release resources, drop native ECS components.
For the full list (`onEnable`, `onDisable`, `fixedUpdate`,
`editorUpdate`, `onPropertyChanged`, `onAssetReload`,
`onModuleReload`,
`onBeforeSave`, …) and the timing details, **read `man components`
— that is the canonical lifecycle reference. Generic component
patterns (declare blocks, public fields, sync, ECS bindings,
typed methods) all live there.**
4. **Public surface.** Fields declared in `public` are inspectable,
editable in the inspector, and persist with the entity. Methods are
declared on that same table with a colon —
`typed function public:method(args)` — and every one of them takes
the component ref as `self`, so a caller invokes it with a colon
too: `entity(id).component.get(name):method(args)`. That is the one
calling convention a component ref answers to: the reflection
methods `ref:fields()` / `ref:getField(name)` /
`ref:setField(name, value)` take the same spelling. A function the
chunk declares at file scope (`function helper()`) is the
component's own, reachable from its hooks under its bare name;
`public` is what the ref carries.
5. **Settings and the Inspector card.** `type.yaml` names the component's
settings schema as `settings: { schema: { instance: "init.luau",
export: "public" } }`: the `public` table IS the schema, and its values
live on each entity the component is on, so `asset.schema(componentRef)`
answers the Field descriptors and no values file exists. On an entity
the Inspector shows the component as a card whose generic `settings`
section edits those fields as typed controls, each edit checked against
the schema and written to the live component as one undoable operation.
`type.yaml` also names `inspector: { instance: "inspector.luau" }`: a
component that ships an `inspector.luau` beside its `init.luau` shapes
its card — the file returns `{ sections, replace, order }` (see
`assetTypes/README.md`, "`inspector:`"), each section's `build(ctx)`
reading `ctx.component` (the live component) and `ctx.selection.id` (the
entity). `SceneModule.component/inspector.luau` replaces `settings` with
the bound module's declared inputs.
6. **Events.** An `events` block declares typed moments the component
fires from inside — `events = { onHit = Event({ dmg =
Field.number(0, NoSync) }) }`. The owner fires with
`events.onHit:fire({ dmg = 10 })`; outside code subscribes through
the proxy's subscribe-only facade,
`entity(id).component.get(name).events.onHit:connect(fn)`
(`:once` / `:wait` too). Pass `Sync` as the event's second argument
to replicate a fire to other peers. Events let one component react
to another's moments without polling. Full reference: **`man
components`**, Events section.
7. **Hot reload.** Editing `init.luau` reloads the component
definition; live instances are reconciled with the new declaration
in-place, and each crosses one lifecycle boundary: `onDestroy()`
ends the running life, then `awake()` and `start()` construct the
one that replaces it, and `update()` resumes on the next frame.
`public` and `private` values carry across; module-level `local`s
belong to the chunk, so the new life starts with them at their
initial values and its `awake`/`start` are what fill them in.
Whatever the old life handed elsewhere — a subscription, a shared
registration, a spawned entity — is released in `onDestroy`, the
call that pairs with the construction about to run. An edit that
leaves the source byte-identical crosses no boundary at all.
A field carries its value across when something stated it: a key of
the `data` table the instance was attached with (a scene record's
data is that table), or a write made since. Every other field takes
the edited source's declared default, so changing a default reaches
every instance that left the field to it. An instance that states
its own value for a field whose default the edit changed keeps that
value, and the reload logs a `[HotReload]` warning naming the field,
the entity, the value kept and both defaults.
## Discovery
- `asset.list("component")` — every registered component (engine +
world + libraries).
- `asset.inspect("<name>")` — identity, scope, public fields,
lifecycle methods, source path, and this type README. `detail`
carries the component's declared `fields`, `methods`, and `events`,
parsed from its source — `tools.use("assets","describe", "<name>")`
renders it as markdown, so a component's events are visible without
opening its source.
- `ls /zero/source/<Name>.component` lists the files the folder holds.
- `entity(id).component.list()` — components attached to an entity.
## Per-frame hooks and the two axes
`engine.mode` (`"edit"` / `"play"`) and `engine.paused` (the gameplay
clock) are independent, and the per-frame hooks read them separately:
- `update(dt)` / `fixedUpdate(dt)` tick while **the gameplay clock is
running** — whichever mode the engine is in.
- `editorUpdate(dt)` ticks while **the clock is held** — because the
mode is `edit`, or because play is paused — and also alongside
`update` whenever edit is running.
Which gives four states, and this table is the contract:
| `engine.mode` | `engine.paused` | hooks that tick |
|---|---|---|
| `edit` | `true` | `editorUpdate` |
| `edit` | `false` | `update`, `fixedUpdate`, `editorUpdate` |
| `play` | `false` | `update`, `fixedUpdate` |
| `play` | `true` | `editorUpdate` |
Entering edit sets `paused = true` and entering play sets it back to
`false`, so a session that never writes `engine.paused` only ever sees
rows 1 and 3 — which is where the shorthand "`update` is the play tick,
`editorUpdate` is the edit tick" comes from. It is the two default rows
of a four-row table, not the rule.
**Row 2 is the one that surprises.** With `engine.paused = false` in
edit — set by hand, or by a tool that advances the gameplay clock to
sample it, such as a `capture.collage` given a `duration` — `update` and `editorUpdate`
both fire, once each, every frame. A component that declares both and
routes them to one body therefore runs that body **twice per frame**:
```luau
local function drive(dt) ... end
function update(dt) drive(dt) end
function editorUpdate(dt) drive(dt) end -- twice per frame in row 2
```
Nothing reports the doubling; it reads as an animation running at twice
its intended speed. To get exactly one tick per frame in every row, ask
which axis you meant and answer it in the body:
```luau
function update(dt) drive(dt) end
function editorUpdate(dt) if engine.paused then drive(dt) end end
```
A scene `entrypoint.luau` declaring the same two hook names is dispatched
by the scene loader, not by this table: there `update` needs play AND
running, `editorUpdate` needs edit, and play-paused ticks neither. Read
`man scenes` before carrying a component's rule to an entrypoint.
## Authoring conventions
- Annotate public fields with `--!desc` so the inspector + LSP show
documentation alongside the field name.
- Declare lifecycle hooks (`start`, `update`, `onDestroy`) explicitly
rather than relying on engine defaults — readers can see at a glance
what runs when.
- Keep `update(dt)` cheap — it runs every frame per instance. Move
heavy work to `start`, to a `.computeShader`, or behind a job (`man jobs`).
- For multi-entity batching, prefer
`tools.use("entityOps", "addComponents", targets, components)` over
a loop of `entity(id).component.add` — it takes many targets and
many components in one call.
## Common pitfalls
- **Naming.** The component identity is the folder stem with
`.component` stripped (e.g. `<Spinner>.component/` → identity
`Spinner`). Don't repeat the suffix in the identity passed to
`component.add`.
- **`init.lua` vs `init.luau`.** Either is accepted (it's a
`one_of_group: "entrypoint"`), but `.luau` is canonical. Mixing both
in one folder is invalid.
- **`update` in edit mode.** It runs whenever the gameplay clock is
running, and entering edit stops that clock — so `update` is idle in
a freshly-entered edit session and ticks again the moment anything
sets `engine.paused = false`. Use `tools.use("wld", "play")` to test
update logic under the mode it ships in; `tools.use("wld", "edit")`
to return. See **Per-frame hooks and the two axes** above.
- **Renaming.** Renaming the folder changes the identity. References
to the component are recorded against the component itself, so
renaming or moving it does not break them.
## Related types
- `.module` — pure-function library, no per-entity state.
- `.service`: a declarative content generator, no per-entity state.
- `.preset` — a captured component configuration, replayable into
`component.add` without re-typing fields.
- `.bundle` — entity hierarchies that may carry component attachments
as part of the bundle.
## In the Inspector
Fields: its execution order, hooks, and how many methods and events it declares, then the fields its `public` table declares as read-only typed controls holding their defaults, with **Check** and **Open** for its entry file. Instances: a link to every entity carrying it. What its card shows on an entity comes from the component's own `inspector.luau`.
▲ 0↑ born
▲ 0↑ born
# Preset (asset type)
A preset is a named set of typed values for one declarer's settings
schema: the texture assetType's, an importer's, a component's, any asset
that declares its own settings. Capture the settings something has now,
then apply them to anything the same declarer governs, instead of setting
the same values by hand each time.
## When to use one
- The same settings recur across many assets or entities (e.g. "pixel
art": every sprite texture with `filter = nearest` and no mipmaps; a
tuned locomotion set for every character of one rig).
- Designers swap configurations without editing code.
- A configuration needs a stable name other content can refer to.
If you're capturing a whole entity assembly, use a `.bundle`. If
you're factoring shared logic (not configuration), use a `.module`.
## Where it lives
- Source: `/zero/source/.../<Name>.preset/`
- Identity: `<Name>` (the `.preset` suffix strips).
- Folder shape:
- `preset.yaml` — the target and the values. **Required.**
- `README.md` — instance documentation. **Required.**
- `.metadata` — agent-editable tags + free-form fields (`title`,
`description`). **Required.**
## The document
```yaml
target: { __ref: "8cc28fc8-ed63-48ee-83a6-15f4192e27e1", type: assetType, name: texture }
values:
filter: nearest
generateMipmaps: false
```
- `target` names the declarer by a guid envelope: `__ref` is its guid;
`type` and the plain `name` tell a person reading the file what it
points at.
- `values` holds only the fields this preset sets. Fields it leaves out
keep whatever the asset or component has.
A component preset has the same shape, its target the component:
```yaml
target: { __ref: "18dfece3-fe1b-4630-b7ad-0996f5043a2e", type: component, name: Locomotion }
values:
walkSpeed: 1.4
runSpeed: 2.5
```
## How to create one
```luau
-- Capture what an asset has now:
local p = preset.capture("hero_sprite", "pixel_art")
-- Capture a component's live values on an entity:
local tint = preset.capture({ entity = id, component = "Model" }, "red_tint")
-- Both land at /zero/source/presets/<name>.preset/ (an absolute `.preset`
-- path lands where it says; `{ overwrite = true }` re-authors an existing
-- preset, keeping its guid).
-- Or author it directly:
asset.create("preset", "pixel_art", {
target = "@builtin::assetTypes.texture", -- an identity or a guid
values = { filter = "nearest" },
})
```
Each checks every value against the target's schema and refuses the whole
write on any violation, naming each one.
## How to use one
- `preset.values(p)` returns `(values, report)`. Every value is checked
against the target's current schema: valid fields are returned, and
each invalid one is listed by path in `report.rejected`.
- `preset.apply(p, into)` writes the valid values into an asset the
target governs, or into a component on an entity named
`{ entity = <id>, component = <name> }` whose component is the target.
A struct group merges field by field; any other field is written whole.
Applying to something another declarer governs raises, naming both.
- `preset.setValues(p, values)` replaces the whole values table, checked
first. Inside an undo operation the write is recorded into it, so undoing
the operation puts back what `preset.yaml` held.
- A preset is a snapshot, not a live binding: applying it writes values
once.
```luau
preset.apply("pixel_art", "enemy_sprite")
preset.apply("synty", { entity = id, component = "Locomotion" })
local values, report = preset.values("synty")
```
## Defaults for new things — the Preset Manager
A world's Preset Manager rows make a preset the starting point for what is
created from then on:
```luau
local p = preset.capture("hero_sprite", "pixel_art") -- or asset.create("preset", …)
preset.addDefault(p, { filter = "sprites/**" }) -- new things only
```
Each row names a declarer, a preset for it, and a filter. For a declarer,
the first row whose filter matches the new thing's path applies. The rows
live in `.world_settings` as `[[presets]]` blocks, sync with the world, and
are edited in the Settings panel's **Preset Manager** section.
**The layers a new thing's settings take**, each over the ones before it,
field by field (a struct group merges field by field):
1. the schema's declared defaults;
2. the type's own `settingsDefaults`;
3. the first matching Preset Manager row;
4. the creating importer's settings for the type;
5. the values the caller passed.
A component takes its `public` defaults, then the row, then the values the
caller passed.
**Rows change only new things.** A row's values are stamped into what is
created while it stands. Editing or removing a row changes nothing that
already exists, and opening a world applies nothing to its saved content. A
re-import or an `overwrite = true` re-authoring keeps the settings the asset
already holds.
**The three creation moments, and what each filter reads:**
| Moment | The row's declarer | The filter reads |
|---|---|---|
| `asset.create` | an assetType whose instances share its schema | the new asset's path under `/source` (`sprites/hero.texture`); a runtime asset reads the path the same call would give a durable one |
| an import | an importer | the source file's path under `/source` at its first import (`sprites/hero.png`) |
| `component.add` | a component | the entity's hierarchy path, names from the root down joined with `/` (`level/props/crate`) |
A component takes a row when it is added in edit mode, and in any mode
inside a scene build (a scene's `build.luau`, a `SceneModule` placement). A
component put back from existing content (a saved scene, a peer's record, a
template, a bundle's hierarchy, what a component's own code adds outside a
build) takes none. A rebuild restates a component only when its code states
it differently, so a row edit alone changes nothing a build already placed.
**Checking what applies:**
- `preset.defaults()` lists the rows in order, each resolved, with every
problem that keeps it from applying.
- `preset.defaultFor(declarer, path)` returns the values a new thing at
`path` would take from the rows, and the row that gives them.
## In the Inspector
Selecting a preset shows, beside its identity:
- **Target** — the declarer as an asset chip and the guid the preset names
it by, with a notice when the target changed since the preset pinned it
or does not resolve.
- **Values** — every field of the target's current schema as its typed
control, the way the target's own Settings section shows it. An edit is
checked against that schema, written with `preset.setValues`, and is one
undo step. A stored value the schema refuses is named with the reason.
Beneath the fields, **Apply to selection** writes the preset into every
selected asset its target governs and into the target component on every
selected entity, as one undo step.
Every asset's and component card's Settings section offers **Save as
preset**, which captures the values it shows as a preset targeting their
declarer and selects it, and **Apply preset…**, which lists the presets
targeting that declarer and applies the one picked.
## How the target stays bound
- The preset resolves its target by the envelope's guid, and the preset's
`.refs` pins that guid together with the target's checksum, so the link
survives the target being renamed or moved. The envelope's `name` is
never an identity, so the guid is the preset's one link to its target.
- Every read re-checks the values against the target's schema as it is
now. `report.pinned` is true once `.refs` pins the target;
`report.targetChanged` is true while the target's checksum differs from
the one pinned, and a field the target dropped or retyped is then
rejected by name while the rest still apply.
## Discovery
- `asset.list("preset")` — every registered preset.
- `asset.inspect("<name>").detail` — `target`, `targetGuid`, `format`,
`values`, `rejected`, `pinned`, `targetChanged`.
- `asset.validate("<name>")` — `preset.target_unresolved` when the target
does not resolve, `preset.value_rejected` for each value its target
rejects.
## Authoring conventions
- Name presets by the configuration they capture (`pixel_art`,
`hdr_skybox`, `synty`), not by the declarer.
- Keep `values` to the fields that define the configuration; fields left
out stay as each asset or component has them.
## Common pitfalls
- **Hand-edited values.** A value the target's schema rejects is
reported, not applied, and every edit of the file warns naming it.
- **A table-valued component field** (a `Field.table`) is written whole
by `preset.apply`, so a preset holding one provides every key of it.
## Related types
- `.assetType` / `.importer` / `.component` — the declarers whose
settings a preset holds.
- `.bundle` — for multi-component / multi-entity assemblies.
▲ 0↑ born
▲ 0↑ born
▲ 0↑ born
# Bundle (asset type)
A bundle is a composable, spawnable entity assembly— a saved entity
hierarchy plus its components, sub-assets (meshes, textures,
animations, materials, sub-bundles), and any nested data, packaged
into a single addressable identity. Bundles are the engine's "prefab"
primitive.
There are **two ways** to bring a bundle into a scene — and the
difference matters enormously for scene saving and live editing. See
"How to spawn" below before you write anything.
If you want one snapshot of a whole world / level, use a `.scene`.
## Where it lives
- Source: `/zero/source/.../<Name>.bundle/`
- Identity: `<Name>` (the `.bundle` suffix strips for use in
identities, but the on-disk folder keeps the suffix).
- Folder shape (container type — open child set):
- `entity_template` — JSON of the entity hierarchy + components.
**Required.**
- `.metadata`: optional.
- Anything else: meshes / textures / materials / animations /
sub-bundles. Validator allows arbitrary additional files
(`allow_unlisted: true`).
## How to create one
Two paths, depending on whether you have an in-scene hierarchy or are
authoring from scratch:
```luau
-- From an existing in-scene entity: composes the given entity tree into a bundle.
local bundle = asset.create("bundle", "<Name>", { entity = entityRef })
-- Or scaffold an empty bundle, then update it from an entity:
local bundleRef = asset.create("bundle", "<Name>")
bundleRef:update(entityId)
```
## How to spawn
### 1. `Asset` component — live-linked (the canonical way)
**This is the primary way to put a bundle into a scene that survives
saving as an asset reference.** Spawn an empty entity, attach the
`Asset` component, point it at the bundle:
```luau
local car = entity.spawn("car_1")
car.component.add("Asset", { source = "<bundleIdentity>" })
```
What you get:
- The bundle's hierarchy spawns as **temporary** children under the
owning entity. They're real, addressable runtime entities, but
they are NOT serialized into `scene.json` on save, only the Asset component and its entity is saved.
- **Live editing of the bundle is supported.** When you edit
anything inside the `.bundle/` (entity_template, meshes,
materials, sub-bundles, components), every entity in the world
carrying that `Asset` component automatically tears down its
spawned children and rebuilds them from the new template — same
frame, no restart, no manual reload. The `onAssetReload` hook in
`Asset.component/init.luau` drives this.
- **Per-instance overrides survive across reloads.** Move a spawned
child, rename it, add/remove components on it, edit a component's
public state — the changes land in the Asset's `public.diff` (a
sparse delta keyed by the child's `original_id`) at save time and
are replayed by `bundleRef:instantiate()` on next load. The bundle stays
a single source of truth; per-spot tweaks ride on top.
- **Stable child ids across reloads.** `public.idMap` records the
`original_id → runtimeId` assignment on first spawn; on every
subsequent spawn the same mapping is reused so cross-entity
references (e.g. `SkinnedModel.skeletonRoot = "ent_xxx"`) stay
valid.
### 2. `bundleRef:instantiate` — baked, no live link
Resolve the bundle and instantiate it onto an entity — this spawns the
children **without** the live-link plumbing the `Asset` component
provides:
```luau
local car = entity.spawn("car_1")
asset.resolve("<Name>", "bundle"):instantiate(car)
```
What you get — and the trade-offs:
- The children spawn as **regular** (non-temporary) entities. On the
next `layers.active:save()`, the entire spawned hierarchy is serialized into
`scene.json` verbatim.
- **No live link to the bundle.** Editing the `.bundle/` after the
fact has no effect on already-spawned hierarchies. The bundle was
effectively consumed at spawn time.
- Scene-save / restore round-trip works the same as for any other
hand-authored entity tree.
Use this path when you want a one-shot expansion of the bundle into
permanent scene state (e.g. you're populating a scene's static
layout from a parametric bundle and don't want a live link).
You can convert a live-linked instance into a baked one explicitly
via `Asset:bakeIntoScene()` — this drops the `Asset` component and
promotes the temporary children to permanent scene entities.
## How it operates
1. **Registration.** Writing into a `.bundle/` folder indexes the
asset with the container-category restore plumbing.
2. **Inner refs.** Component fields that reference assets inside the
bundle use the `__ref` shape (`{ "__ref": "<guid>", "name": "...",
"type": "..." }`). The asset registry resolves them at spawn
time.
3. **Identity.** The `.bundle` suffix is stripped, so a bundle
resolves as `<Name>` (`asset.resolve("<Name>", "bundle")`); the
type argument tells it apart from any `<Name>` of another type.
4. **Hot reload.** Saving `entity_template` (or any file in the
bundle directory) fires the engine's per-asset content-changed
hook, which calls `onAssetReload("source")` on every entity
whose `Asset` component points at the bundle. Each carrier
despawns its children and re-instantiates against the new
template — typically next frame.
## Discovery
- `asset.list("bundle")` — every registered bundle.
- `asset.inspect("<name>")` — sub-asset catalog, source, this type
README.
- `ls /zero/source/<Name>.bundle` lists the files the folder holds.
## Parts and slots
A bundle can be an object assembled from parts, and a part that fills one. A
child carrying a `Slot` component is a named place another part fills (its
`kind`, the `tags` a part must carry, a `default` part, and where the part
attaches: that child's transform). A bundle whose root carries a `Part`
component is a part, and its `fits` names the slot kinds it fits. An
`Assembly` on the root holds what fills each slot by path (`wheel_fl`,
`engine/turbo`, a part's own slots nesting under the slot it fills), and
resolves, swaps and explains them at runtime:
```luau
local car = entity.spawn("car")
car.component.add("Asset", { source = "Buggy" }) -- a bundle with slots and an Assembly at its root
local asm = car.component.get("Assembly")
asm:configure({ wheel_fl = "SportWheel", engine = { part = "V8", turbo = "Turbo" } })
asm:fill("wheel_fl", "OffroadWheel") -- rebuilds that wheel alone
print(asm:fits("wheel_fl", "V8")) -- false, and why
```
The configuration is saved with the scene and synced; the parts are runtime
children rebuilt from it. `guides { path: "topics/assemblies" }` covers the
whole family.
## Authoring conventions
- Prefer `bundle:update()` or `asset.create("bundle", "<name>", { entity = ref })` over hand-authoring `entity_template`. The
in-scene composer wires `__ref` shapes correctly and pulls in every
transitively-needed asset.
- Keep bundles focused — one prefab per bundle. If you have a "vehicle
+ driver + sound" assembly, split into three bundles and reference
them from a scene rather than packing all three into one bundle.
- Name child entities meaningfully — bundle interiors are
inspectable, and stable IDs let other tooling (`entity_template`
edits, animation hooks) find them.
- Sub-bundles compose: a bundle's `entity_template` can `__ref` a
child `.bundle/`. The asset registry resolves them transitively.
## Common pitfalls
- **Confusing the two spawn paths.** `Asset` component = live link,
reference-only scene save. `bundleRef:instantiate()` directly = baked,
full hierarchy in `scene.json`.
- **Copying JSON between bundles.** A copied `entity_template` does not
bring the assets it references along with it; re-compose from a
live scene rather than copy-pasting JSON.
- **Live editing only fires for live-linked carriers.** Already-baked
entities don't update when you edit the source bundle.
## Related types
- `Asset.component` — the canonical mount point for a live-linked
bundle. See its README for the `idMap` / `diff` machinery in
detail.
- `.scene` — owns a whole world's worth of entities; spawns bundles
into itself via `Asset` components on per-spot entities.
## In the Inspector
Selecting a bundle opens its **Contents** section, from the bundle's inspect detail: the template's node count, its root, the component types attached across it, a table of each renderable node's mesh and material, and a link to each of those meshes and materials.
▲ 0↑ born
# Model
Loads and displays a 3D mesh on an entity. Disabling the component hides the mesh. Supports procedural meshes (`cube`, `sphere`, ...), model files, and remote URLs. Tint and outline are shader effects applied to the mesh.
**Material lives on this component.** There is no standalone `Material` component — a material only renders where there is a mesh to render it on, so the `material` field is part of Model (and SkinnedModel). Set it at add time or assign the field later; properties are registry-wide.
Public fields: `model`, `material` (`AssetRef<material>`), `tintR/G/B`, `tintBlend`, `outlineR/G/B`, `outlineIntensity`, `outlineOccluded` (`"hide"`, the default, hides the rim where geometry stands in front of the mesh; `"dashed"` draws it there in dashes, the `occluded` choice of `@builtin::modules.outline`).
Methods: `:setTint(color, blend?)` (color: `{r, g, b}` array or `{r=, g=, b=}` map), `:clearTint()`, `:setOutline(color, intensity?)`, `:clearOutline()`, `:setMaterialProperty(prop, value)`, `:getMaterialProperty(prop)`, `:getMaterialPropertyNames()`.
```luau
entity(id).component.add("Model", { model = "cube", material = "gold" })
entity(id).component.get("Model").material = "checkerboard" -- swap material
entity(id).component.get("Model"):setTint({1, 0, 0}, 0.5)
entity(id).component.get("Model"):setMaterialProperty("roughness", 0.2)
```
**Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many entities (a stress map, a heat map, a damage flash, per instance colour) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing and costs about a twentieth of a tint write. `guides { path = "topics/rendering-instance-data" }` has the lane layout.
▲ 0↑ born
# Text3D
Renders text in 3D world space. The quad auto-sizes to fit the text content and never clips. Positioning works like TextMeshPro: `offsetX/Y/Z` is a local offset from the entity, `pivotX/pivotY` is the anchor within the quad, and `billboard` makes it face the camera. With `billboard = false` the text reads from the entity's own forward, the local -Z that `transform.forward` reports and that `entity:lookAt` aims.
Sizing — three fields, two jobs:
- `worldHeight` — the quad's height in **world units** (default `1.0`). This is the one field that resizes a label, and it holds that height under every transform between the label and the world: a label hung off a shrunken detail box on a model comes out the size it asked for, and so does one whose own entity carries a `localScale`. Width follows the rasterised text's aspect. Measure the result with `getWorldSize()`, which reports the extent the quad is drawn at.
- `fontSize` — the **raster resolution** in texels (default `32`). Higher values sharpen the texture and change wrapping against `maxWidth`; the world-space size stays `worldHeight`.
- `scale` — rasterisation scale multiplier applied at raster time. Resolution only, like `fontSize`.
`maxWidth` is the width the text wraps at, in pixels of the raster `fontSize` states; `0` keeps it on one line. A label already drawn is laid out again when the field is written, so a caller re-wraps one label to line after line rather than making a label per line.
`alphaCutoff` decides whether the letters are a surface. At `0` (the default) the text is pure alpha blending: it draws over what is behind it and leaves the depth buffer alone, so a screen-space effect that reads scene depth — volumetric fog, screen-space shadows — integrates the whole distance behind the letters and the text sits inside it. Above `0`, coverage at or over the threshold is drawn opaque and written to depth, so those effects stop at the glyph shape instead. `0.5` reads well for most fonts; higher thins the letters, lower keeps more of the antialiased edge.
Public fields: `content`, `fontSize`, `color`, `alignment`, `richText`, `maxWidth`, `outline`, `outlineColor`, `background`, `scale`, `worldHeight`, `alphaCutoff`, `shadowX/Y`, `fontFamily`, `weight`, `slant`, `offsetX/Y/Z`, `pivotX/Y`, `billboard`. `weight` and `slant` are strings (`"regular"` / `"bold"`, `"normal"` / `"italic"`).
Methods: `setText(content)`, `setStyle(options)`, `getText()`, `getSize()`, `getWorldSize()`, `refresh()`.
```luau
entity(id).component.add("Text3D", { content = "Hello World" })
entity(id).component.add("Text3D", { content = "HP: 100", worldHeight = 0.5, fontSize = 96, color = "red", offsetY = 2.0, pivotY = 0 })
-- A title that keeps its letters crisp through volumetric fog.
entity(id).component.add("Text3D", { content = "RAISING", worldHeight = 3.0, alphaCutoff = 0.5 })
```
A label that is not showing, or came out in a face you did not ask for, reads
back out of the text system: `text.observe()` lists every live text object with
the entity that owns it and the texture its raster is in, and `text.face(h)`
names the font face the shaper actually used against the `fontFamily` that was
requested. `topics/text` walks both.
▲ 0↑ born
# scene_instantiable (module)
The instantiation contract's shared implementation. An asset type opts into
scene instantiation by defining `instantiate(self, target?, opts?)` on its
behaviour `ref` table; this module carries the parts that mean the same thing
for every type, so a caller writes ONE piece of code against all of them.
```lua
local root, idMap = ref:instantiate(target?, opts?)
```
## The contract
**IN — the base opts.** `target` is an owning entity ref: the instance lands
under (or, for a hierarchy type like a bundle, onto) that owner. With no
target the type spawns a fresh root. `position`, `rotation`, `scale`, `name`
and `temporary` place that root and mean the same for every type. `rotation`
takes three numbers as pitch/yaw/roll in DEGREES, or four as a quaternion. A
type may honour more opts of its own — `params` for a type built from declared
inputs, `idMap` / `diff` / `sourceTag` for the bundle override contract — and
says so in its own `instantiate` docs.
**OUT — the two returned values.** Every type returns the same pair:
- **`root`** — the composed root, as an `EntityRef`. Composition is
**synchronous**: the root and everything the type built under it are live
the moment the call returns, so a caller can parent to it, read its
components and hand it on in the same statement. There is no frame to wait
for and no callback.
- **`idMap`** — the `originalId -> runtimeId` map naming what the composition
spawned, `{}` for a type with no addressable children. **Never nil.** A
component that re-composes the asset on every load (`Asset`) keeps this map
and passes it back in, which is how a cross-entity reference into the
composition — `SkinnedModel.skeletonRoot` pointing at a bone — survives a
reload.
The return is enforced, not merely described: `AssetRef` dispatches every
`ref:instantiate(...)` through `result` on the way out, whether or not the
type called it. A type that returns something else fails at its own call
rather than handing its caller a nil root or a map that is sometimes absent.
## Exports
- `M.root(self, target?, opts?) -> root` — stand the root entity for a type
that spawns one: parented to `target`, born temporary when
`opts.temporary`, named `opts.name` else the asset's own name, placed.
- `M.place(root, opts?) -> root` — apply the placement opts to a root the type
already has (the adopt path: a bundle exploding onto its target, a
sceneModule reconciling under one).
- `M.result(self, root, idMap?) -> (root, idMap)` — return through the
contract. Checks `root` is a live entity ref, normalises a missing map to
`{}`, and errors naming the asset type when either is something else.
- `M.isOwned(opts?) -> boolean` — whether a component drives this call. The
`Asset` / `SceneModule` components tag their own calls with `sourceTag`;
they hold the reference and re-compose on every load. An untagged call came
straight from `ref:instantiate(...)` and has no such owner.
- `M.own(root, self, idMap?) -> root` — hand an already-composed root to an
`Asset` component pointing at `self`, so the reference and its map persist
and the composition is rebuilt on the next load. The component adopts the
live composition rather than building a second one.
- `M.check(value, constraint) -> ok, reason?` — the `sceneInstantiable`
field-constraint validator, also registered under that kind on load.
## The field constraint
`Field.instantiableRef` emits `constraint = { kind = "sceneInstantiable" }`,
and this module registers the validator for it on load. Given a written value:
1. `nil` passes — the field is optional (no asset assigned).
2. Reads the value's identity — a bare string, or a table's `__ref` / `guid` /
`identity` / `name`.
3. Resolves it (`asset.resolve(identity)` — any category) and asks the
resolved ref `ref:canInstantiate()`: true iff the asset's type defines an
`instantiate` method.
This is what lets `Field.instantiableRef` accept by CAPABILITY rather than a
hardcoded type list — a new scene-instantiable asset type is accepted the
moment it defines the hook, with no edit to the field or its consumers.
▲ 0↑ born
# rigStructure
The shape of a skeleton, read from a `.rig` document or a live `Skeleton`: parents and children,
the rest pose's world positions and rotations (rest scale included), and the questions an avatar
type asks of that shape. A structure is memoized by the content hash of the bones it was built
from, so reading the same skeleton twice builds it once.
```luau
local rigStructure = require("@builtin::modules.rigStructure")
local s = rigStructure.fromDoc(asset.resolve("PolygonSyntyCharacter", "rig"):doc())
local hips = rigStructure.lca(s, s.byName["Ankle_L"], s.byName["Ankle_R"])
print(s.bones[hips].name, rigStructure.reach(s, hips, { 0, 1, 0 }))
```
| Call | Answers |
|---|---|
| `fromDoc(doc)` / `fromBones(bones)` | The structure: `bones`, `n`, `byName`, `parent` (0 for a root), `children`, `depth`, `order` (parents first), `gPos`, `gRot`, `gScale`, `hash`. Indices are 1-based. |
| `hash(doc)` | The content hash over names, parents and rest transforms. |
| `subtree(s, i)` / `leaves(s, i)` | The bones below `i`, and its leaves. |
| `path(s, from, to)` | The bones from `from` down to `to`, or nil when `to` is not below it. |
| `lca(s, a, b)` | The deepest bone both descend from. |
| `reach(s, i, dir)` | How far the subtree at `i` reaches along `dir`. |
| `extremity(s, i, origin)` | The subtree bone farthest from `origin`. |
| `chainLength(s, from, to)` | Summed link lengths from `from` down to `to`. |
| `mirrorScore(s, a, b, origin, side)` | 0..1: how well subtree `b` reflects onto subtree `a` across the plane through `origin` with normal `side`, and how alike their lengths are. |
| `extent(s, dir)` | Lowest and highest projections of any bone onto `dir`. |
A bone whose parents loop back on themselves is cut from its parent and read as a root, so every
walk over a structure ends.
▲ 0↑ born
# PlayerNameLabel
Drives this entity's `Text3D` with the owning player's name, read from the nearest ancestor `PlayerAvatar`'s synced `displayName` so every peer renders the same name without a local registry lookup. The label re-rasterises when the display name changes, and in play it hides itself on the local player's own avatar, since name labels exist so other players are identifiable. A label shows a name or nothing: an avatar with no `PlayerAvatar` (a stock avatar placed as a non-player character) or one whose `displayName` is empty has its label's text emptied and the label hidden.
Location: `src/lua/lib/components/PlayerNameLabel.component`
▲ 0↑ born
# bodyFacing
Which way a skinned body bundle visibly faces, measured from its skeleton, and
the turn that stands it facing -Z, the forward every entity states.
An entity's forward is its local -Z: `transform.forward`, `entity:lookAt`, a
`PlayerSpawn`'s heading, `capture`'s local `front` and `Locomotion`'s default
`forward` all read it. A body file faces whichever way its art pipeline
authored it (+Z for a Synty or Rocketbox FBX, a VRM 1.0 or a Khronos-convention
glTF, -Z for a VRM 0.x, sideways or lying down under the nodes of some
exports). A body composed under a `front` entity turned by
`alignment(front(parts(bundle)))` faces the -Z of `front`'s parent whatever its
file did. `Locomotion.forward` is stated in the frame of the child of its
entity that it turns, so `front` sits under that child:
```
character (placed, turned by lookAt / a spawn)
body (Locomotion turns this one about up)
front (alignment(front(parts(bundle))))
<bundle nodes>
```
```luau
local bodyFacing = require("@builtin::modules.bodyFacing")
local body = entity.spawn("body", { parent = character.id })
local front = entity.spawn("front", { parent = body.id })
front.localRotation = bodyFacing.alignment(bodyFacing.front(bodyFacing.parts(bundle)))
bundle:instantiate(front)
```
The avatar asset type composes every body this way, and
`characterController.install` composes the mesh it is given this way under its
`character_mesh` child.
## Exports
- `parts(body) -> parts?` — what a body bundle is made of: `{ bundle, meshes,
rig, unit, up, template }`, the bundle, the skinned meshes its template's
SkinnedModels name, the `.rig` of the first, metres per rig unit and the
body's vertical in the rig's space. Nil for a body with no skinned mesh or
source rig.
- `front(parts) -> { x, 0, z }?` — the way the body visibly faces at rest in the
frame its bundle is composed into: the rig's facing (the hip line crossed
with the stand axis) turned by the rotations of the skinned mesh's record and
every record above it, so a Z-up skeleton stood upright by a node is measured
as it is drawn. Nil for a body whose rig names no hips, neck and legs.
- `frontInTopRecord(parts, front) -> { x, y, z }?` — that front in the frame of
the record holding the skinned mesh among the children of the entity the
bundle is composed onto, the record a `Locomotion` on that entity turns.
- `alignment(front) -> { x, y, z, w }` — the turn about +Y that stands `front`
on -Z; the identity for a nil front.
▲ 0↑ born
# avatarStandard
The humanoid avatar standard every carried avatar is built around, so a game can
rely on the avatar a visitor arrives with: where a hat or a held item goes, where
the eyes are, which expressions the face has, and how tall the body is.
```luau
local avatarStandard = require("@builtin::modules.avatarStandard")
local d = asset.resolve("my_hero", "avatar"):descriptor() -- an avatar asset
local d2 = entity(playerId).component.get("Humanoid"):descriptor() -- a live player's body
local v = asset.resolve("my_hero", "avatar"):validate()
for _, p in v.problems do print(p.rule, p.name, p.message) end
```
## The standard
- **Bones**: the 55 VRM 1.0 humanoid bones (`avatarStandard.bones`), each filled
through the humanoid avatar type's structural detection whatever the rig names
its bones. 15 are required: `hips`, `spine`, `head`, and per side `UpperLeg`,
`LowerLeg`, `Foot`, `UpperArm`, `LowerArm`, `Hand`. `avatarStandard.roleOf`
maps a VRM name to the humanoid role (`rightHand` -> `righthand`). The eyes and
the jaw are found by name among the head's own bones.
- **Attachment points**: 19 (`avatarStandard.points`): `origin`, `hat`, `hair`,
`faceFront`, `faceCenter`, `neckBase`, `leftCollar`, `rightCollar`,
`leftShoulderTop`, `rightShoulderTop`, `bodyFront`, `bodyBack`, `waistFront`,
`waistCenter`, `waistBack`, `leftGrip`, `rightGrip`, `leftSole`, `rightSole`.
Each is placed from the body's own proportions, and its frame is the avatar's
axes on the body standing in a T-pose with its palms down (+Y up, +Z forward, +X
the body's left), carried by the anatomy of the bone under it. A grip's +Z
leaves the fist on the thumb's side; a sole's +Z points toward the toes.
- **Viewpoint**: between the eyes when the body has eye bones, else in front of
the head at eye level.
- **Expressions** (`avatarStandard.expressions`): the VRM presets are the
required face tier (`aa ih ou ee oh`, `blink blinkLeft blinkRight`,
`lookUp lookDown lookLeft lookRight`, `happy angry sad relaxed surprised`,
`neutral`); `neutral` is the face at rest and the look presets are met by eye
bones too. The Oculus 15 visemes and ARKit's 52 shapes are optional tiers. A
blend shape answers a preset by its name (case and separators ignored, VRChat's
`vrc.v_` viseme prefix read); an avatar whose shapes are named otherwise maps
them in `avatar.json`:
`"expressions": { "aa": "Mouth_A", "blink": { "shape": "Eyes_Closed", "overrideMouth": "block" } }`
(`overrideBlink`, `overrideLookAt`, `overrideMouth` take `none`, `block` or `blend`).
- **Height band**: `avatarStandard.heightBand`, 0.5 to 3 m.
## The descriptor
Positions and rotations are in the avatar's own space: metres, +Y up, +Z the way
the body faces, +X its left, from the ground beneath its hips. Up is the body's
own vertical (an avatar asset's bundle stands it on +Y; a live avatar stands on
its root's up), so a spine that leans in the rig leans in the descriptor too.
| Field | Holds |
|---|---|
| `standard` | `"humanoid/1"` |
| `conforms` | true when the body breaks no rule |
| `bones` | `{ [vrmBone] = boneName }` for every VRM bone the body fills |
| `chains` | the body's optional chains by class (`hair`, `ear`, `tail`, `chest`, `skirt`, `face`, `attachment`, ...), each `{ root, bones }` |
| `points` | `{ [point] = { role, bone, position, rotation, local } }`; `local` is the same frame in the carrying bone's own space |
| `viewpoint` | `{ role, bone, position, rotation, local, source }`, `source` `"eyes"` or `"estimate"` |
| `expressions` | `vrm` (`{ [preset] = { shape?, source, override } }`), `visemes`, `arkit` (`{ [name] = shape }`), `missing` (the VRM presets nothing answers), `tiers` (`{ vrm, visemes, arkit }`, each true when the body has the whole tier) |
| `height`, `bounds`, `band` | the body's height (ground to crown), the extent of its skeleton, and the band the standard takes; `height` and `bounds` are nil for a body with no humanoid frame |
| `proportions` | metres, for sizing what the body wears: `head` (crown above the head joint), `shoulderWidth`, `hipWidth` (between the upper-arm and upper-leg joints), `torso` (hips to the base of the neck), `arm` (shoulder joint to wrist), `leg` (hip joint to the ground) |
| `scale` | 1 for an asset; for a live body, its avatar root's world scale, so it stands `height * scale` tall in the world |
| `problems` | every rule broken, each `{ rule, name, message }`, `rule` one of `type`, `bone`, `point`, `expression`, `height` |
`validate` answers `{ ok, problems, summary }`; `summary` says the problems in
one line per broken rule ("missing 3 required bones: rightUpperArm,
rightLowerArm, rightHand"), in the player's language, for showing a player why
their avatar was turned away. The lines come from the library's
`avatar_standard` catalog; a world words them its own way with an
`avatar_standard.json` of its own (`summary.bone_one`, `summary.bone_other`,
`summary.height`, ...). A live body is held to the height band at the height it stands in the
world (`height * scale`).
`validate(body, { rules })` holds a body to the rules a game relies on
(`avatarStandard.rules`: `type`, `bone`, `point`, `expression`, `height`; all of
them by default). A game whose players need no faces leaves out `expression`:
```luau
local v = h:validate({ rules = { "type", "bone", "point", "height" } })
```
`describe(body)` takes an avatar asset or a live avatar entity, which both state
the body's units; `validate(body)` answers `{ ok, problems }`. A bare `rig` states
no units (the built-in Synty rigs are in centimetres), so describe one through an
avatar that wears its body, or with `describeStructure(structure, opts)` (`opts`:
`qualification`, `unit` in metres per rig unit, `up` the body's vertical in the
structure's space, `morphTargets`, `expressions`). Without `up` the avatar's
space stands on the humanoid frame's up, from the hips toward the chest.
Seat items on the points with `Humanoid:attach(point, itemId, opts)` (the
Humanoid component's README); `Humanoid:attach("viewpoint", cameraId)` seats a
first-person camera at the eyes.
▲ 0↑ born
# Asset
Promote the bundle's spawned children from temporary to permanent scene state and remove the Asset component, "baking" the bundle's contents directly into the owning scene. Subsequent saves persist the baked entities verbatim and stop replaying the bundle template.
Location: `src/lua/lib/components/Asset.component`
▲ 0↑ born
# humanoid
The humanoid avatar type: a body with two legs, a spine, a head and one or two arms.
`qualify(structure)` finds the body from the skeleton's shape, so any bone naming works
(Mixamo, Unity, VRM, CATS, Unreal, Synty, or no meaningful names at all):
- The **hips** are where two mirrored chains reaching the skeleton's lowest point (the legs)
branch from a chain rising to its highest point (the spine). A bone above the hips is the
`root`.
- The **arms** are the two mirrored chains branching sideways near the top of the spine; above
that branch the chain continues through the neck to the **head**.
- A **hand** is where an arm ends in a fan of fingers; the thumb is the finger set apart from
the others.
- A **foot** is where a leg turns forward; the next bone is the toe base.
- **Left and right** come from the body's facing (the direction the feet point), never from names.
- A **four-legged body** declines: its spine runs across the legs, or it leans well off the
legs while the legs stand extended and a limb hanging from the chest reaches down toward the
ground the feet stand on. A crouching biped leans and reaches low too, on folded legs.
Names only raise confidence and break ties. A name that contradicts the geometry is reported in
`report.contradictions` and does not change the side.
Every other branch is a **secondary chain**, classed `hair`, `ear` or `face` (on the head),
`chest` (paired, forward, on the upper spine), `butt` (paired, backward, on the hips), `tail`
(single, backward, on the hips), `skirt` (a ring of downward chains on the hips), `attachment`
(a single leaf bone such as a prop socket) or `other`.
A rig that is not a humanoid declines with a one-line `reason` naming the first requirement it
missed. See the `avatarType` asset type's README for the full result shape.
▲ 0↑ born
# references
What content of a carried mount means by the asset references it holds. A carried mount holds the closure of an asset of another world, and that content names assets the way its own world named them: by the guid, path or identity the closure states. Read at the site of the asset holding them, inside the mount, those references name the closure's own copies (each known in this session by its session guid) and the engine library at the version the closure was built against, through `asset.tryResolve(ref, type, site)`. The open world's asset under the same guid or name is another asset.
A bundle of a carried mount composes from its template through `records`, and an `Asset` instance of it measures its overrides against the same records, so a reference the closure answers is the same value on both sides.
## Exports
- `M.site(path, identity?) -> (site?, prefix?)` - where an asset of a carried mount stands: its path in the mount (its carried identity when no path is given) and the prefix its mount spells content with (`@carried.<key>::`). Both nil for an asset of the open world.
- `M.close(value, site, prefix) -> value` - a copy of decoded component data with every asset-reference envelope (`{ __ref, type?, name? }`), at any depth, naming what the closure at `site` means by it: the guid it resolves to there, or, while the mount answers nothing for it, the reference spelled in the mount (`@carried.<key>::<reference>`), which waits on the mount and applies once the mount holds the asset. A component reference (`componentType` beside `__ref`) stays as written.
- `M.records(template, path, identity?) -> template` - the records of an entity template as the asset at `path` composes them: closed through `close` for an asset of a carried mount, `template` itself for an asset of the open world.
## Usage
```luau
local references = require("modules.api.engine.carried.references")
local records = references.records(bundleRef:getTemplate(), bundleRef.path, bundleRef.identity)
local site, prefix = references.site(bundleRef.path, bundleRef.identity)
if site ~= nil then
local data = references.close({ material = { __ref = guid, type = "material" } }, site, prefix)
end
```
▲ 0↑ born
# Humanoid
Marker component for entities carrying a skeleton conforming to the
standard humanoid bone layout (Synty / Unreal-Mannequin convention).
Content reads a humanoid body's bones and attachment sockets through this
component instead of re-walking the descendant tree, and seats items on
those sockets with `:attach`.
## Bone naming convention
```
Hips
Spine_01 → Spine_02 → Spine_03 → Neck → Head
└ Eyes, Eyebrows, Jaw
UpperLeg_R / UpperLeg_L
LowerLeg_R / LowerLeg_L
Ankle_R / Ankle_L
Ball_R / Ball_L → Toes_R / Toes_L
Clavicle_R / Clavicle_L
Shoulder_R / Shoulder_L
Elbow_R / Elbow_L
Hand_R / Hand_L
IndexFinger_01..04 / Thumb_01..04 / Finger_01..04
```
Mixamo / Unity-Humanoid imports go through a bone-rename pass at import
time (tracked separately).
## Fields
| Field | Type | Notes |
|---|---|---|
| `height` | number | Foot-to-head height in T-pose, metres. Default 1.8. |
| `eye_height` | number | Foot-to-eyes height, metres. Default 1.65. |
| `bones` | `{ [string]: entity }` | Computed; bone-name → entity-proxy map. Re-walks on read. |
| `sockets` | `{ [string]: entity }` | Computed; role (`righthand`, `head`, …) → the bone filling it on this body, through the body's RetargetProfile. |
## Methods
| Method | Returns | Notes |
|---|---|---|
| `:bone(name)` | `entity \| nil` | Nil-safe single-bone lookup; same as `self.bones[name]`. |
| `:socket(point)` | `entity \| nil` | The bone at a role, or at an exact bone name. |
| `:attach(point, childId, opts?)` | `entity \| nil` | Seats `childId` on the socket bone at the socket's frame, moved by `opts.position` / `opts.rotation` / `opts.scale`. Position and scale are metres in the humanoid's own space, whatever bone units the rig was authored in; rotation is relative to the bone, as a quaternion `{ x, y, z, w }` or Euler degrees `{ pitch, yaw, roll }`. An option outside those three, or a value in none of those forms, raises with the item left as it was. Returns the socket bone. |
| `:attachments()` | `{ { id, point, position, rotation, scale } }` | Every item seated with `attach`, with the point and transform it was seated with. An avatar body swap re-seats each on the new body. |
## Usage
```luau
-- Read a specific bone
local h = entity(playerId).component.get("Humanoid")
local head = h.bones.Head -- entity proxy
local handR = h:bone("Hand_R") -- nil-safe lookup
-- Seat a hat 12 cm above the head, on any humanoid body
local hat = entity.spawn("hat")
h:attach("head", hat.id, { position = { 0, 0.12, 0 } })
-- Read height for camera mounting
local cam = entity.spawn("eye_cam", { parent = playerId })
cam.localPosition = { 0, h.eye_height, 0 }
```
## Tag convention
Bundles carrying a humanoid skeleton tag themselves with both
`playerVisual` AND `humanoid` in their `.metadata`. Tooling can filter
to humanoid-conforming visuals via
`asset.list("bundle", nil, { fields = { tags = { "playerVisual", "humanoid" } } })`.
▲ 0↑ born
# json
JSON encode/decode library for Luau. Encodes Lua values to JSON
strings and decodes JSON strings back to Lua values. Used for
communication with the Rust side of the engine, the VFS read/write
bridge, and any wire-format that needs JSON.
Pure Luau, no engine dependencies. Compact and pretty-printed
encoders, plus a hand-rolled decoder that streams the input by position
so it works under WASM as well as native.
## Exports
- `Json.encode(value: any, indent?: string, currentIndent?: string) -> string` — compact encode. Functions / unknown types and NaN/Inf encode as `null`.
- `Json.encodePretty(value: any, indentStr?: string) -> string` — pretty-printed encode with sorted object keys (diff-friendly).
- `Json.encodeArgs(...: any) -> string` — encode varargs as a JSON array.
- `Json.decode(str: string) -> any` — decode a JSON string. Returns the decoded value, or `nil` + error message on failure.
## Usage
```luau
local Json = require("@builtin::modules.json")
local widget = { type = "button", text = "Click Me" }
local compact = Json.encode(widget) -- '{"text":"Click Me","type":"button"}'
local pretty = Json.encodePretty(widget, " ")
local decoded = Json.decode(compact)
local v, err = Json.decode("oops") -- v = nil, err = error message
```
## Notes
- Object keys are sorted alphabetically in both encoders for consistent
output across runs.
- Numeric keys on objects are stringified at encode time (JSON has no
numeric keys). Pure-integer key sets get detected as arrays via
`isArray` and encoded with brackets.
- NaN, +Inf, -Inf encode as `null` — JSON has no representation. Round
trips through `decode` recover `null` (Lua `nil`), so they don't
preserve.
- Unicode `\uXXXX` escapes decode to UTF-8 by hand to stay WASM-safe.
Only the BMP is covered; supplementary planes via surrogate pairs
are not.
- Functions encode as `null`.
- Decode is character-streamed — no regex, no `string.match` patterns
on the whole input — so the line-and-column information needs to be
reconstructed from the position offset.
▲ 0↑ born
▲ 0↑ born
# SkinnedModel
Component that drives skinned model playback and animation graph integration.
Like `Model`, it carries the `material` field (`AssetRef<material>`) — material lives on the model that renders it, not as a standalone component. Set it at add time or assign `entity(id).component.get("SkinnedModel").material = "..."` later; `:setMaterialProperty` / `:getMaterialProperty` / `:getMaterialPropertyNames` operate on the assigned material (registry-wide).
**Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many characters (a damage flash, a team colour, a heat map) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing. `guides { path = "topics/rendering-instance-data" }` has the lane layout.
## Blend model
`skinning` chooses how the pass combines a vertex's joint influences.
- `"linear"` (default) averages the joint matrices themselves. The average of
two rotations is not a rotation, so a strongly twisted joint loses volume
toward its axis — at a 180° twist a limb collapses onto the axis entirely.
- `"dualQuaternion"` averages the joints' rigid motions as unit dual
quaternions and renormalises, so the blend is a rotation at every weight and
the cross-section is carried through the twist. Non-uniform joint scale rides
along as a separately blended stretch. It costs a quaternion extraction per
influence, so it is worth setting on characters whose wrists, shoulders or
spine twist far, and leaving off elsewhere.
```lua
entity.find("hero").component.get("SkinnedModel").skinning = "dualQuaternion"
```
A rig at rest renders identically under either model.
## Render self-check
A few frames after its mesh attaches, a SkinnedModel checks that the mesh
names something the engine can draw (on the GPU, or held off the device until
this display puts it back) and that the pose it is drawn in has not collapsed it: the
posed vertices the skinning pass wrote are measured against the mesh's own
bind-pose extent, so a 1 cm part of a prop is judged by its own size. A mesh
that fails is swapped for the builtin ERROR marker, drawn un-skinned with the
error material, and the reason is logged. Setting `model` again takes the
marker down and checks the new mesh.
`renderCheck()` answers the verdict: `{ state = "pending" | "passed" |
"failed" | "skipped", reason }`.
```lua
local v = entity.find("prop_part").component.get("SkinnedModel"):renderCheck()
if v.state == "failed" then print(v.reason) end
```
▲ 0↑ born
# avatarMapping
How a skeleton maps onto an avatar type, read and corrected.
```luau
local avatarMapping = require("@builtin::modules.avatarMapping")
local subject = avatarMapping.subject("my_hero", nil, "me") -- an avatar, bundle, rig or avatar entity
local before = avatarMapping.report(subject) -- every role, its bone, detected or set by hand
local roles = avatarMapping.overrides(subject.rig, subject.type)
roles.leftforearm = "mixamorig:LeftForeArm"
avatarMapping.setOverrides(subject.rig, subject.type, roles, "me")
print(#avatarMapping.diff(before, avatarMapping.report(subject)).roles)
print(avatarMapping.scores(subject.rig).worst.slide) -- bakes idle, walk and run onto the rig
```
- `subject(v, type?, who)` reads what a mapping is about: an avatar (its body's rig, under
the avatar's own type), a body bundle, a rig, or a live avatar entity.
- `report(subject)` states every role with its bone, `source` (`detected`, `override` or
`cleared`), the confidence of its chain, and the type's report: missing chains,
ambiguities, names that disagree with the structure, overrides naming bones the rig lacks.
- `overrides(rig, type)` and `setOverrides(rig, type, roles, who)` read and write the
author's `{ [role] = bone | false }` a rig keeps for one type, in its `rig.json`, which a
re-import keeps. A rig a library ships keeps no overrides from a world.
- `diff(before, after)` states the roles whose bone moved.
- `scores(rig, clips?)` bakes clips onto the rig and measures the foot slide and joint angles.
The `avatar` toolbox (`avatar.inspect`, `avatar.map`, `avatar.unmap`, `avatar.detect`,
`avatar.promote`) and the avatar, bundle and rig inspectors read and write through it.
▲ 0↑ born
# assetType runtime
The machinery that reads a `<typename>.assetType/behavior.luau` and turns its
declarations into live behaviour.
A `behavior.luau` is a table of declarations — `ref` methods, `modules` shared
code, an `events` schema, a `namePattern`, `refShapes`, and the `onCreate` /
`onRegister` / `onChange` / `onDelete` / `validate` / `settingsDefaults` /
`settingsCorrections` hooks. None of it runs itself. This is the code that
runs it, and it lives here because reading a type's declarations is the
**assetType type's own behaviour** — the same way `material.assetType` owns
what a `.material` does.
## Sub-modules
| Module | Reads | Responsibility |
|---|---|---|
| `ref.module` | `ref`, `modules` | Builds every `AssetRef` envelope, attaches the shared metatable, and dispatches per-type methods and shared modules onto it. Also owns edit-mode write-behind persistence. |
| `create.module` | `onCreate`, `namePattern`, `validate` | Backs `asset.create`: resolves the type, checks the name against its pattern, runs `onCreate` (or clones `template/`), and writes the instance. `validate.module` beside it checks a creation `opts` table against the type's `createSchema`. Before running `onCreate`, resolves the type's settings chain (below) and hands the result to the hook as `opts.settings`. |
| `settings.module` | `settings`, `settingsDefaults`, `settingsCorrections` | A type's declared settings schema and where its values live (`type.yaml`'s `settings:` block). `Settings.resolveForCreate` layers the schema's own defaults, the type's own `settingsDefaults(name, opts, asked)` hook (a DEFAULT the schema can't express — a name-derived convention, a fact read off a payload the caller handed it, a value following a field `asked` shows a higher layer naming; any later layer overrides it), the Preset Manager, an importer's settings, the caller's `settings` table, then the type's own `settingsCorrections(values, name, opts)` hook (a CROSS-FIELD CONSTRAINT the schema can't express, applied last over the fully merged values). A correction over a default/preset/importer value lands silently; a correction that would override what the caller's own `settings` table explicitly asked for refuses the creation instead, naming the field and why. Neither hook is ever handed a table to mutate; each returns what it wants changed (`settingsCorrections` may also return a `{ [field]: reason }` table for that refusal message). `Settings.cloneValues` deep-copies a values table — `create.module` hands `onCreate` a copy, never the table it stamps. `Settings.valuesOf` / `writeValues` read and write an asset's own values file. |
| `typeYaml.module` | `type.yaml` | The folder a type lives in and its parsed `type.yaml`, decoded once per content version of the file. `settings.module` and `inspector.module` read their blocks through it. `about` / `aboutAt` read a type's `about.yaml` (`intent`, `function`, `usage`), leaving out any key that is empty or still starts with `[[describe]]`; `aboutRows` and `aboutMarkdown` lay the texts out for the Inspector and the `types/<name>` guide. |
| `inspector.module` | `type.yaml`'s `inspector:` block | Which inspector a type declares for its assets (`inspector: { type: ... }` or `{ instance: ... }`), and the declaration that file returns — the sections it adds, the generic ones it replaces, and their order — or the problem that kept it from loading. |
| `onRegister.module` | `onRegister` | Fires an instance's once-only registration hook — on arrival, on world load, and for `@builtin` library instances. |
| `changeDispatch.module` | `onChange`, `onDelete`, `refShapes` | Routes a VFS source write or a folder delete to the enclosing typed asset's type hooks. |
| `refShapes.module` | `refShapes`, `ref` | Publishes what every `AssetRef<category>` answers to, so a member read on an asset-typed value is checked against that category's real surface. |
| `events.module` | `events` | The per-asset event runtime behind `ref.events`. |
| `instantiable.module` | `ref.instantiate` | The instantiation contract an asset type opts into: `root` stands the root entity, `place` applies the base placement opts to one the type adopted, and `result` shapes the `(root, idMap)` every `instantiate` returns. Also registers the `sceneInstantiable` field-constraint validator. |
| `declaration.module` | `type.yaml` | The type's decoded declaration, read once and held until a write inside an `.assetType` folder; what every question about a type as a whole reads. |
| `previewRecipe.module` | `type.yaml` `preview:` | How an instance's `preview.png` is produced: which of the four recipes (`instantiate`, `image`, `surface`, `custom`) the type declares, and what that recipe needs. |
## Reaching it
```luau
local rt = require("@builtin::assetTypes.assetType.shared")
rt.ref.loadTypeBehavior("material")
```
Fields resolve lazily. The prelude requires the sub-modules directly, in
dependency order (`ref`, then `changeDispatch`, `onRegister.install()`,
`refShapes.install()`) — a table that required all six on load would take that
ordering away from it.
▲ 0↑ born
backing path · avatars/humanoid.avatar
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
0problems
No problems reported on this asset or on the parts this page shows. Parts it leaves out are not counted here.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up
agent_score is exposed.usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ quality × 0.35
+ performance × 0.25
± compat factor
+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
—%no reports yet
Sign in to report whether this part worked for you.
Discussion
Scoped to this part · feeds back into the world's score.
0comments
Sign in to post.sign in
No comments yet. Be the first.