# avatar.attach
Seat a part of the avatar's own on its body (ears, horns, an antenna, a tail, a backpack):
a mesh hung from an attachment point, carried by the bone under it on every player's
screen. A part of the same name is replaced, so a second call adjusts it.
# avatar.colour
Change the colours of the avatar being worn: its body by colour region (`body`, and the
regions an avatar names, such as `hair`) and its own parts by name. `#rrggbb`, or false to
take a colour off.
# avatar.create
Make a new avatar the world owns: a copy of a starting avatar (the library's humanoid by
default), optionally wearing another body (a rigged character bundle) and carrying parts
(ears, a hat, an antenna) from the start, checked against the avatar standard.
# avatar.detach
Take one of the avatar's own parts off it by name, with the toggle `avatar.toggle` made
for it.
# avatar.detect
Run detection again on a skeleton under one avatar type or every type the world sees, and
compare it with the mapping in force: per type whether it qualifies (confidence, or the
type's reason) and every role where the detected bone differs from the hand-set one. Names
the best qualifying type.
# avatar.dress
Put an item on the avatar being worn on a slot (hat, face, held, back, any attachment
point), replacing what the slot wore, or take it off with false. Worn items are part of the
look and ride `avatar.save`.
# avatar.emote
Give the avatar a gesture or an emote (a wave, a bow, a dance) the person plays from the
Emotes page of their expression menu and every player sees: an `.animation` clip, or a pose
or keyframes whose bones may be named by humanoid role or VRM bone name.
# avatar.inspect
Read one avatar whole: how its body maps onto its avatar type (each role with its bone,
detected or set by hand, and the confidence of its chain), the mapping report, the
secondary chains, what the avatar standard reads from the body (height, proportions,
attachment points, broken rules), its own parts, parameters, animator layers and expression
menu, and for an avatar standing in the scene the look it wears. Takes an avatar, a body
bundle, a rig or an avatar entity. The first call when a character stands still, twists
when it walks, or wears an item in the wrong place.
# avatar.list
Every avatar the world sees (the library's starting bodies and the world's own) with its
body, whether it is humanoid, its parts and parameters and whether it can be edited here,
and the avatar standing in the scene now.
# avatar.map
Say by hand which bone fills a role of an avatar type (or `false` to leave it empty) when
detection put the wrong bone there or found none. The override is kept on the rig for that
type, laid over what the type detects, and survives a re-import; the result states what
changed in the mapping and the report. `avatar.unmap` gives the role back to detection.
# avatar.preview
A picture of an avatar in the preview studio, as built or as the look being worn now
(colours, body shape, worn items), turned with `angle`. The picture comes back to the caller.
# avatar.promote
Make a playable avatar of a rigged body bundle: its skeleton qualifies as the avatar type
named (or the best of every type the world sees), and the avatar is written of that type
with its defaults. A skeleton no type takes is refused with each type's reason.
# avatar.save
Save the look being worn as an outfit on the signed-in person's account, by default the
look they wear in every world. The engine asks the person first; when the account will not
take it from an agent, the person's Outfits tab is opened for them to save it.
# avatar.shape
Change the body shape of the avatar being worn: its standing height in metres and its
width across the body. Part of the look, so it rides `avatar.save`.
# shared Module
Helpers every tool of the `avatar` toolbox reaches with `require(".shared")`:
- `shared.avatar(v, who)` names the avatar asset an agent means: an avatar ref, identity
or guid, or an avatar standing in the scene.
- `shared.subject(v, type, who)` is what a mapping tool works on (an avatar, a bundle, a
rig or a live avatar) with the rig and the avatar type it is read under.
- `shared.mappingReport(subject)` states every role with its bone, whether the bone was
detected or set by hand, the confidence of its chain, and the report; `mappingDiff`
states what changed between two of them.
- `shared.readDefinition` / `shared.writeDefinition` read and write an avatar's
`avatar.json`, checking its parts, parameters, animator and menu before the write.
- `shared.lookRoot`, `shared.currentLook` and `shared.wearLook` find the live avatar a look
is worn on and wear a document on it.
# avatar.toggle
Give the person a switch for one of the avatar's parts: a saved on/off parameter, an
animator layer showing and hiding the part on every screen, and a toggle in the avatar's
expression menu (the app menu's Expressions tab).
# avatar.unmap
Clear a role's hand-set override so the avatar type's detection fills it again, or every
override the rig keeps for the type when no role is named. States what changed.
# avatar.validate
Check an avatar before a person wears it or a game relies on it: the humanoid avatar
standard (skeleton, bones, attachment points, face expressions, height), its parts,
parameters, animator and expression menu with their cost, and the look a live one wears.
# avatar.wear
Wear an avatar: the local player's body becomes it while someone plays; in edit mode it
stands in the scene as the "Avatar stand". The look already worn (colours, body shape, worn
items) stays on it.
# toolbox (asset type)
A toolbox is an asset grouping set of `<tool>.tool` assets around one area of work. Each tool in
it becomes callable under the toolbox `<toolbox>.<tool>`, and is a shell command,
`zero <toolbox> <tool> <args>`; `guides core/tools`, "A tool's command line", covers its
flags, paths, `render.luau` and exit status.
## When to group tools together
When creating tools for the engine, a common theme should be identified and
and a toolbox created to house them, this allows each individual operation
to be easily accessible instead of being scattered in a million places.
## Sharing functionality between tools
A toolbox features ability to define functions that code inside each individual tool
inside it can access, this is usefull when establishing helpers etc so you dont have
to duplicate code for each new tool you write.
A `shared.module` inside the toolbox root is where this code lives,
each tool inside a toolbox can access its functions by requiring it with `require(".shared")`.
```luau
-- <toolbox>.toolbox/shared.module/init.luau
local M = {}
-- One step a tool reports in its result.
export type Step = { name: string, ok: boolean, detail: string? }
--!desc Check that a numeric argument lies within bounds.
--!arg arg The argument's name, for the error.
--!arg value The value passed.
--!arg min The lowest value allowed.
--!arg max The highest value allowed.
--!return The value; raises naming the argument and the range when it lies outside.
--!example "count", 12, 1, 100
typed function M.range(arg: string, value: number, min: number, max: number): number
if value < min or value > max then
error(string.format("%s must be between %s and %s, got %s", arg, tostring(min), tostring(max), tostring(value)))
end
return value
end
--!desc A byte count as a readable size.
--!arg bytes The count.
--!return The size in B, KB, MB or GB.
--!example 2681107
typed function M.size(bytes: number): string
local units = { "B", "KB", "MB", "GB" }
local i = 1
while bytes >= 1024 and i < #units do
bytes /= 1024
i += 1
end
return if i == 1 then string.format("%d %s", bytes, units[i]) else string.format("%.1f %s", bytes, units[i])
end
--!desc A step for a tool's result.
--!arg name What the step did.
--!arg ok Whether it succeeded.
--!arg detail What happened, when there is more to say.
--!return The step.
--!example "copy textures", true
typed function M.step(name: string, ok: boolean, detail: string?): Step
return { name = name, ok = ok, detail = detail }
end
--!desc The asset of `kind` that a caller named, looked up by that name.
--!arg kind The asset type to look in.
--!arg name The name the caller passed.
--!return The asset; raises naming the kind and name when nothing matches.
--!example "material", "gold"
typed function M.named(kind: string, name: string): AssetRef
local ref = asset.tryResolve(name, kind)
if ref == nil then
error(string.format("no %s named '%s'", kind, name))
end
return ref
end
return M
```
This shared code should be limited to being used by the tools inside it,
dont put general functionality you might need otuside the toolbox into its shared module.
Instead reference those in the shared module should you wish to utilize something.
A benefit the shared module shares with the tools own code is that it allows
the author to write code that has computed references, meaning eg resolving
an asset from a computed variable `asset.resolve(<type>,name)` that is normally
not allowed in other parts of the engine surface, due to said references not being
recorded.
This is usefully for utilizing tools to handle operations that are called by users/agents
and are dynamic in nature, such as finding/inspecting/testing assets, or content based on an input etc.
When writing a shared module, you should follow standard module practices, please see `module.assetType` readme.md
for more indepth information.
## Describing the toolbox
When writing the readme for your toolbox, ensure you focus on the overall
area what the toolbox focuses on, rather than listing individual tools inside it,
discovery surfcaces already group tools and toolboxes together so a toolbox can be discoverd
by the tools it hosts and doesnt require separately maintaining a list of the tools in it's readme.
## What are tools and when do i create ones?
Tools are typed operations with a known serialized output format, made to enable efficient operation in the engine and provide an easily callable interface for operations around a topic.
They are also useful in that they can be called from a multitude of surfaces, from `execute`, to `bash` to `tool_exec`
to users Tools portion in the edui.
A toolbox and its tools differ from eg a module that has multiple callable functionm in that they might return anything,
and come with no guarantee that the output is meant to be inspected directly, where as tools are meant to perform an self contained operation and return results/info/relevant data in a readable format, including eg. image data.
Whenever you identify an operation that requires specific orchestration and or is something that could be a repeated operation and makes it easier to manage the project/task or when you want to expose logic written in `luau`
to the other call surfaces like `bash` under its `zero` command,you should reach for creating a toolbox.
Toolboxes also come in handy for limiting control/inputs, exposing a limited set of functionality in a clean manner or ensuring the caller doesnt have to understand the entire code.
For comparison, you could think of toolboxes as programs, and the tools inside them as commands.
A package might contain tens of tousands of lines of code, dozens of modules, components etc,
a toolbox turns that surface into a system that any agent/user can then utilize without having
to read or understand the code inside.
Its the UI equilevant to operations.
For the indepth explanation of what `tool.assetType` is and does, read it's readme.
# tool (asset type)
A tool is one named operation: a single luau `typed function` inside a toolboxe's `<name>.tool` asset,
callable as `<toolbox>.<tool>`. The function's signature is the tool's interface,
so anyone can call it correctly without reading its code.
A tool is also a shell command, `zero <toolbox> <tool> <args>`; `guides core/tools`,
"A tool's command line", covers its flags, paths, `render.luau` and exit status.
Each tool has a declared input shape and return shape; the engine wraps each call's
result in an envelope.
## Why use a tool?
Tools are typed operations with a known serialized output format, made to enable efficient operation in the engine and provide an easily callable interface for operations around a topic.
They are also useful in that they can be called from a multitude of surfaces, from `execute`, to `bash` to `tool_exec`
to users Tools portion in the edui.
Compared to say a `module.assetType`, that might contain multiple functions with varying shapes, experct references or specific formats of tables as input and could return potentially anyting including flat tables.
that has multiple callable functionm in that they might return anything a tool is meant to be called with a serialized value, and return a serialized value.
A tool is meant to perform an self contained operation and return results/info/relevant data in a readable format, including eg. image data.
Whenever you identify an operation that requires specific orchestration and or is something that could be a repeated operation and makes it easier to manage the project/task or when you want to expose logic written in `luau`
to the other call surfaces like `bash` under its `zero` command, it propably should be a `<name>.tool` asset.
## How tools are written
In its simplicity, a tool is a single Typed luau function that returns a value.
written plainly, in its basic form it could look like this.
```luau
-- probe.toolbox/onCall.tool
--
-- Fire when a named function runs, seeing its arguments and what it returned.
--- A toolbox offered shared module, that in this case,contains a type shared by the tools in their toolbox.
local shared = require(".shared")
local M = {}
export type OnCallResult = {
ok: boolean,
id: string?,
result: string?,
error: string?,
}
--!desc example tool
--!arg path target path for the operation
--!arg opts `{ notice, when?, run?, capture?, label?, limit?, cooldown?, freeze?, silent? }`.
-- `capture` is Luau, compiled against the hit's context the way `run`
-- is, that returns a picture for the hit — a capture tool you aim:
-- `return tools.use("capture", "fromEntity", { entity = entity })`. It
-- runs once the hit is recorded, and the hit's notice then carries the
-- picture under `shot`, delivered as a picture.
--!return `{ ok, id, result }`.
--!example "arg1", arg2
typed function M.gatherResults(path: string, opts: shared.ArmOpts): OnCallResult
local modulePath, key = splitPath(path)
--- the tool code implementation
local results = myCodeResults
--- the tool call returns a table with keys, that is then wrapped in a return envelope.
return { ok = true, id = results.id, result = results.gathered }
end
return M
```
Now when called, the tool runs and returns the envelope with the inspectable results.
## Why return plainly, and fail by raising
Every caller gets a tool's outcome in the same form, success or failure, so
return the value itself and raise an error when the tool can't do its job. A
tool that returns its own `{ ok = false }` reads as a success that happened to
return that table. Make the error say what to do instead: the caller reads it
and acts on it.
## What the shell prints
`zero <toolbox> <tool>` prints the text the tool's `render.luau` states: a
module in the tool's folder returning one function `(result) -> string |
{ out, err?, exit? }`. A returned string is the output, and `{ out, err?, exit? }`
sets the output, the standard error text and the exit status. A call that raises
exits 1, and a command line the shell cannot bind to the tool's parameters exits 2.
## When to answer later instead of blocking
A caller waits for the tool to return, and might be calling multiple tools at the same time.
Should your call run past the waiting threshold in order to return, even if it yields
it comes back as a handle to a background task that will then complete on its own,
but require the caller to separately read the task results.
For a call that is small, answering inline with the result is better. When a
tool can tell that this particular call will be long (a big bake, a large
batch, a slow fetch), it hands itself to the background with
`task.background()` early, so the caller gets the handle at once and carries on
with other work.
## When to post a notice
The return value is the answer to what was asked. A notice is for what the
caller needs to know besides that: a side effect it didn't ask for, a return to one that has no caller,
notices should be treated as a way to make sure your tool can return quickly, when you arent sure how
long it takes for the results to be ready. It allows the agent to continue working, and then react when
the notice fires. `notices.post` delivers it to the caller,
and an agent that is idle is woken by it, so the caller learns it without
polling. Name in it what to do about it. A notice for something the return
value already says is noise.
## Returning more than text
Tools also support returning images, that the agent can then directly read from the tool response, regardles
of what surface they used to call the tool.
Images also work on notices, so you can eg attach visual results to the eventual outcomes of
your tool results and the agent will see them the second the notice fires.
## What a tool may do that other code may not
A tool, and code only tools call, may act on whatever an input names, resolving
an asset by a name that only arrives with the call. That is what makes a tool
the place for operations that depend on what they are given. Tools are for
working on a world rather than running in the game: a component may not call
one unless it declares `declare { componentSafe = true }`, and a tool doesn't
call another tool, so logic several tools need goes in the toolbox's shared
module or exist elsewhere.
For information how to group tools and organize them, and how they are called read `toolbox.assetType` readme.
## In the Inspector
Tool: how the tool is called (its signature), what it does, each argument, what it returns, and its examples, with **Open** for its source.
# Module (asset type)
A module is a reusable, stateless (or globally-stateful) Luau library
that other code pulls in with `require()`. Modules are the unit of
factored-out logic in a world: helpers, math libraries, format
parsers, registries, shared algorithms.
## When to use one
- You have logic you want to share across multiple components,
services, scenes, or tools.
- You have a registry, lookup table, or shared cache that callers all
read from / write to.
- You want a stable API surface (`M.fn`) other code can depend on.
If the logic is bound to one entity, use a `.component`. If you want a
named UI of fields rather than functions, use a `.preset`.
## Where it lives
- Source: `/zero/source/.../<name>.module/`
- Identity: the source path with `/` written as `.` and each segment's
type suffix dropped — `/zero/source/demo/beats.module` is
`demo.beats`, and `/zero/source/kit.package/beats.module` is
`kit.beats`, the container's name kept and its `.package` suffix
gone. `asset.create` returns this string, `asset.resolve(...).identity`
reads it back, and the `require` forms below write it as
`<identity>`.
- Folder shape:
- `init.luau` (or `init.lua`) — module body. **Required.** Returns
a table (conventionally named `M`).
- `README.md` — instance-level documentation. **Required.**
- `.metadata` — agent-editable tags + free-form fields. **Required.**
## How to create one
```luau
asset.create("module", "<name>")
-- Creates: /zero/source/<name>.module/
-- init.luau (canonical `local M = {} … return M`)
-- README.md (instance README template)
-- `folder` places it in a subfolder of /source, and that subfolder
-- leads the identity: `{ folder = "lib" }` produces `lib.<name>`.
-- `into` authors it inside a resolved container (a package, a toolbox),
-- whose own identity leads the same way:
asset.create("module", "<name>", { folder = "lib" })
asset.create("module", "<name>", { into = asset.resolve("myPkg.package") })
```
## How it operates
1. **Registration.** Writing `init.luau` into a `.module/` folder
indexes the asset and registers the module path with the resolver.
2. **Loading.** The first `require("<identity>")` runs
the file's body and caches the returned table. Subsequent requires
from anywhere return the **same table** — this is the
shared-state lever for "module-local" registries. The body runs in
an environment of the module's own: a name it declares without
`local` is readable by the module's own functions and by no other
script, so an export reaches its callers through the returned table
and nothing else. Requiring a component's folder runs its chunk the
same way, once, and its `update`, `start` and `public` stay in that
environment; a component runs on an entity through
`entity(id).component.add(name)`.
3. **Hot reload.** Editing the file re-runs the module body and folds
what it returns into the table already loaded, so that table keeps
its identity: a caller that captured it with `require` reads the new
source's functions and values through the reference it already
holds, and a later `require` returns that same table. A key the new
source drops goes away; a key something set at runtime stays. The
body's own `local`s start again from their initial values, so state
that must outlive an edit lives in `modules.state()`
(`guides { path: "core/scripting-and-tasks" }`).
4. **Identity resolution.** A module is reached by its `<identity>`,
and where the caller lives decides which spelling of it resolves.
For a module in a **world**, from a caller in that same world —
another module, a component, a scene entrypoint, or an `execute`
chunk:
- `require("<identity>")` — the identity on its own, resolved
against the caller's own root. It carries every folder segment,
so a module created with `{ folder = "demo" }` is
`require("demo.beats")`.
- `require("@root::<identity>")` — the same root-relative
resolution, written out.
- `require(".sibling")` — a module in the same folder, by its bare
name; `..name` steps up one folder, `...name` two.
Logs, stack traces and hot-reload notices name that same module
`@local.source.<identity>` — its key under the world source root.
The `<identity>` tail of that key is the form above, so a trace
reading `@local.source.demo.beats` is `require("demo.beats")`.
For a module in a **library** — content under
`/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's
root from anywhere: `require("@builtin::modules.transform")`.
Mounting a world as a library moves its files under such a root and
flips the caller root to `@<lib>::`, which is what keeps the
root-relative forms above resolving across the move.
## Discovery
- `asset.list("module")` — every registered module.
- `asset.inspect("<name>")` — public functions, source path, this
type README.
- `ls /zero/source/<name>.module` lists the files the folder holds.
## Authoring conventions
- Return a single `M` table from `init.luau`. Top-level statements
with side effects run on first require — useful for one-time
initialization, dangerous if they touch the engine before it's
ready.
- Write exported functions as `typed function`, not `function`: the
argument types are enforced at the call and the checker knows the
signature, so a caller's mistake is reported where they made it.
- Annotate exported functions with `--!desc` / `--!arg` / `--!return`
/ `--!example` so the LSP, `tools.list`, and `asset.inspect`
surface them. A function with no `--!desc` is reachable only by
someone already reading this file.
- Declare a VALUE with `Field.<kind>(default, mode, description)`, and
a table whose members are reached through a metatable with
`--!members <TypeName>` — the latter gives the surface its accepted
member set, its type, and its documentation from one table. See
`guides { path: "core/authoring" }` for all four rules and
`modules/api/engine/entity.module/members.module` for a worked
member table.
- Keep module state in module-local upvalues or in `modules.state()`.
A name the body declares without `local` lives in the module's
environment, which every run of the module shares: a function the
previous run left in place reads what the reload assigned. Module-locals start again from their
initial values with each hot reload; the table `modules.state()`
returns is the same table on both sides of every reload.
- Prefer focused modules over kitchen-sink modules. If two halves of a
module have no shared state, split them.
## Common pitfalls
- **Cyclic requires.** A `require` chain that loops will return the
partial table (the half built before the cycle was detected).
Design for one-way dependencies.
- **Engine-time side effects.** Don't `entity.spawn` at module
top-level — the engine may not be ready. Expose an `M.init` and
call it from a scene entrypoint.
- **Hot-reload + module-local cache.** A module that caches
expensive computation in upvalues loses that cache on reload —
fine for dev, but be aware in performance work.
- **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical.
- **Writing one while play runs.** A `/source` write made while play is
running lands on the play shadow, and a guarded play-exit discards it
unless it is kept. One `.module` write shadows `init.luau`, the
`README.md` and the `.metadata` together.
`vfs.write(path, bytes, { durable = true })` skips the shadow, and
`vfs.promotePlayShadow` keeps what is already on it — the `core/vfs`
guide has the model and what each route costs.
## Related types
- `.component` — for entity-bound state + lifecycle hooks.
- `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider.
- `.tool` — for a single agent-callable function with a YAML schema.
- `.package` — to group several modules + components + scenes into
one shippable folder.
## In the Inspector
Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
# shared
Cross-tool helpers for the [name] toolbox. Every tool inside the
toolbox can pull these in with `require(".shared")`. Holds the small
set of helpers that more than one tool needs: toolbox-wide parsers,
validators, formatters or shared state. Per-tool implementation stays
inside each `<x>.tool/init.luau`.
## Usage
```luau
local shared = require(".shared")
typed function M.someTool(id: string): { id: string }
return { id = shared.normalizeId(id) }
end
```
A tool returns its value, and `error(message)` fails it. The text
`zero [name] <tool>` prints, the error text and the exit status are set
by the tool's `render.luau`.
## Notes
- Keep helpers pure where possible: no engine calls, no state, so they
are safe to call from any context.
- Per-tool implementations own their own `--!desc` / `--!arg` /
`--!return` / `--!example` annotations.
# 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.
# 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.
# avatarAppearance
How a person wears an avatar, as one data document, and how the engine
composes it onto a live avatar on every peer.
```luau
local avatarAppearance = require("@builtin::modules.avatarAppearance")
local doc = avatarAppearance.new("@builtin::avatars.humanoid")
doc.body_shape = { height = 1.9, width = 1.1 }
doc.colours = { body = "#3366cc", hair = "#201008" }
doc.worn = {
{ slot = "hat", item = "@builtin::meshes.cone", adjust = { y = 0.06, scale = 0.25 } },
{ slot = "held", item = "@builtin::meshes.cylinder", adjust = { z = 0.1, scale = 0.1 } },
}
doc.animation_pack = "@builtin::systems.characterController.presets.synty" -- a Locomotion preset
doc.emotes = { "<emote guid>", "<emote guid>" }
doc.parameters = { moveSpeed = 3 }
assert(avatarAppearance.validate(doc).ok)
local root = asset.resolve("@builtin::avatars.humanoid", "avatar"):instantiate()
local r = avatarAppearance.apply(root, doc) -- { changed, pending, unapplied }
-- a player's body: layers.active.players.localPlayer.avatar (the avatar root)
print(#avatarAppearance.encode(doc), avatarAppearance.address(doc))
```
## The document
The fields are ZeroMind's appearance document, field for field, so an outfit an
account saved reads as it is:
| field | what |
|-------|------|
| `v` | `1` |
| `avatar` | the avatar asset reference |
| `body_shape` | named numbers; `height` (metres) and `width` (a factor) are composed |
| `colours` | `#rrggbb` / `#rrggbbaa` per region; `body` is every mesh of the body the avatar's `regions` (in `avatar.json`) gives no other region; the items seated on its points (the avatar's own `parts`, the worn items) keep their own colours |
| `worn` | the worn items in order: `{ slot, item, adjust? }` |
| `animation_pack` | a Locomotion preset reference |
| `emotes` | emote asset guids (uuids, stored lowercase and hyphenated), in menu order |
| `parameters` | named bools, numbers or strings; `moveSpeed`, `sprintMultiplier` and `tintBlend` are composed |
A worn `slot` is one of the 19 standard attachment points (`hat`, `rightGrip`,
`bodyBack`, ...; see `avatarStandard`) or a slot alias: `held` (`rightGrip`),
`offhand` (`leftGrip`), `back` (`bodyBack`), `face` (`faceFront`), `neck`
(`neckBase`), `waist` (`waistCenter`). `adjust` takes `x`, `y`, `z` (metres in
the point's frame), `pitch`, `yaw`, `roll` (degrees), `scale`, and `sx`, `sy`, `sz`
(a factor along one axis, times `scale`: `{ scale = 0.05, sy = 9 }` stretches a
cylinder into a stick).
`encode` writes the canonical bytes (compact JSON, fields in schema order, map
keys sorted), `address` their sha256, `decode(bytes, address?)` reads them back
and checks them against an address, and `validate` names every rule a document
breaks (ZeroMind's bounds, at most 4096 bytes, and the standard's slots and
adjustments).
## Composing
`apply(root, doc)` composes onto a live avatar root and, applied again with
another document, recomposes only what differs: an item both documents wear
stays as it is. `read(root)` is the document composed there, `worn(root)` the
items with the entities spawned for them, `settle(root)` seats items whose
point waits for the body's skeleton, and `clear(root)` takes it all back off,
returning the avatar to how it stood before the first document. `diff(a, b)` states what differs between
two documents.
## Games
`override(doc, rules)` is a game's view of a player's document; the player's
document is unchanged. A `worn` rule reaches every item worn on the point its
slot names, by whichever name the document gives it (`held` reaches an item
worn as `rightGrip`):
```luau
local seen = avatarAppearance.override(doc, {
worn = { hat = "my_helmet", held = false }, -- replace the hat, take the held item away
body_shape = { height = { min = 1.6, max = 1.8 } }, -- clamp the height for the match
animation_pack = "my_pack", -- force a pack
})
```
The `Appearance` component carries the document and the rules on an avatar
root as synced data, so every peer composes the same character.
## Outfits and the profile
`outfits(answer?)` is a set of named outfits with one current, in the shape
ZeroMind answers `GET /v1/me/appearance` in (`{ current, outfits }`):
`:save(name, doc, { makeCurrent })`, `:get`, `:list`, `:wear`, `:current`,
`:remove`, `:toJson`. `fromDescriptor(descriptor)` reads a ZeroMind profile's
`avatar_descriptor` (a builtin body, a tint, a height, motion) as the document
ZeroMind's own mapping gives, value for value (the descriptor's numbers are
32-bit floats), so both have one address.
## The account
The signed-in person's account keeps their outfits and the one they wear. A
player wears their account's look on the body that binds when they join a world
(or switch modes): the current outfit's document, read by its address, else the
document their profile `avatar_descriptor` maps to. It is written into the
body's `Appearance` component, so every peer composes it. A body without
`Humanoid` wears nothing, and a game's `Appearance` rules still apply over it.
```luau
local me = avatarAppearance.accountAppearance() -- { ok, outfits, current?, look?, from?, address? }
avatarAppearance.saveOutfit("Pirate", doc, { makeCurrent = true })
avatarAppearance.wearOutfit("Pirate") -- by name or id; nil wears none
avatarAppearance.deleteOutfit("Pirate")
avatarAppearance.wearAccountLook() -- the local player wears the account's look again
```
`saveOutfit`, `wearOutfit` and `deleteOutfit` change how the person appears to
everyone, so the engine asks them in its own dialog first, whoever calls, and
the local player then wears the account's new look. ZeroMind refuses them to an
agent's own account (`code = "AGENT_APPROVAL_REQUIRED"`); the person makes
those changes on the app menu's Outfits tab (`appMenu.open("outfits")`,
`modules.api.engine.outfits`). An engine that booted
offline is signed in to no account and answers `{ ok = false, offline = true }`.
# 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.
# Appearance
Carries how the person behind an avatar wears it, as one appearance document
(`modules.avatarAppearance`), on the avatar root: the entity carrying
`Humanoid`, which is `player.avatar` for a player. The document and a game's
override rules are synced data of a few hundred bytes: every peer receives
them and composes the same character on its own engine, so no mesh, bone or
worn item is sent. Writing a new document recomposes only what differs from
the one before.
```luau
local avatarAppearance = require("@builtin::modules.avatarAppearance")
local doc = avatarAppearance.new("@builtin::avatars.humanoid")
doc.body_shape = { height = 1.9 }
doc.colours = { body = "#3366cc" }
doc.worn = { { slot = "hat", item = "@builtin::meshes.cone", adjust = { y = 0.05, scale = 0.2 } } }
local body = layers.active.players.localPlayer.avatar -- the avatar root (it carries Humanoid)
body.component.add("Appearance", {})
local look = body.component.get("Appearance")
look:wear(doc) -- the person's document
look:override({ worn = { hat = "my_helmet" } }) -- the game's view of it
print(look:size(), look:address(), look:get().worn[1].item)
```
- `document` (synced): the person's document as its canonical JSON. Emptied
(`:wear(nil)`), the avatar returns to how it stood before the first document.
- `rules` (synced): the game's override rules as JSON; the person's document stays as it is.
- `:wear(doc | nil)`, `:get()`, `:effective()`, `:override(rules | nil)`, `:address()`,
`:size()`, `:emotes()`, `:composed()`.
Location: `src/lua/lib/components/Appearance.component`
# 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.
# preview
Render an asset's preview in the preview studio: an isolated camera, lit only
by its own three-point rig, over a neutral backdrop, that nothing in the scene
reaches. `ref:preview()` renders any asset by the recipe its type declares under
`preview:` in its `type.yaml`, and these are the primitives it calls: they spawn
temporary entities, frame an offscreen camera over them, render one frame,
read it back as a PNG, and tear the entities down.
## Surface
- `preview.fromEntities(makeFn, opts?) -> PreviewResult` — run `makeFn` to
instantiate entities, frame a camera to their bounds, render one offscreen
frame, and return the still PNG.
- `preview.fromRecipe(ref, recipe, opts?) -> PreviewResult` — render `ref` by a
declared recipe: `instantiate` stands it through its own `instantiate`,
`surface` paints the material its type's `ref.previewMaterial` returns on the
recipe's mesh, and `image` fits a file the asset holds to the frame on the
studio backdrop without rendering anything.
- `preview.backdrop() -> { r, g, b }` — the studio backdrop's colour in a
finished preview, 0-255.
`PreviewResult` is `{ available, imageBase64?, rendered?, width?, height?,
bounds?, stats?, reason? }` — `imageBase64` is the rendered PNG when `available` is true, and
`reason` explains why when it is false. `opts` is `{ size? = { width, height },
angle? = { yaw, pitch } }`.
A preview pictures its whole subject, however many entities it composes. While
the subject settles, its bounds are measured each frame by walking it in Luau
for up to `opts.entityBudget` entities (default 2000); a subject composing more
is measured by the capture framing alone, which reads each root's hierarchy
bounds from the engine.
## Example
local result = asset.resolve("gold", "material"):preview({ size = { width = 512, height = 512 } })
-- result.imageBase64 holds the rendered PNG (base64)
# 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.
# luau_introspect (module)
Parses Luau/asset source TEXT into structured declarations. Pure
string/pattern parsing (`string.find` / `string.match` / `string.gmatch`)
over the literal source — no compiling, no VM spawn, no runtime state, no
engine FFI. Given source text, it extracts what is written in the file.
This is the shared parser every per-assetType `M.ref.inspect` hook uses to
turn a component/module/tool's own source into the structured record
`asset.inspect` returns.
## Exports
- `docstrings(src) -> DocMap` — scans `--!desc` / `--!arg` / `--!return` /
`--!example` comment runs and binds each run to the name of the
declaration on the next non-comment line (the identifier after
`function`, `public:`, `local function`, or `M.`).
- `publicFields(src) -> { FieldEntry }` — parses `public = { name =
Field.<kind>(default, mode), ... }` table-literal entries and
module-scope `public.<name> = Field.<kind>(...)` assignments.
- `events(src) -> { EventEntry }` — parses `events = { name =
Event(payloadSchema?, syncMode?), ... }` table-literal entries.
- `methods(src) -> { MethodEntry }` — parses `function public:<name>(...)`
/ `typed function public:<name>(...)` declarations (params + optional
return type).
- `lifecycleHooks(src, catalog) -> { string }` — top-level `function
<name>(` declarations whose name is in the caller-supplied `catalog`
array.
- `moduleExports(src) -> { ExportEntry }` — parses `M.<name> = function`
assignments, `function M.<name>(...)` declarations, and a trailing
`return { foo = foo, ... }` export table.
- `forSource(src, computeFn) -> any` — memoises `computeFn(src)` keyed on
`src` itself in a module-local table. The same source text returns the
cached result without re-running `computeFn`; different source text
recomputes. Keyed on the source content (not an asset checksum) because
composite/container assets (component folders, scene folders, etc.) all
hash to the empty-string checksum — a checksum-keyed cache collapses
every such asset's detail onto whichever one was inspected first.
## Usage
```luau
local Introspect = require("modules.luau_introspect")
local src = self:getInitScript()
local detail = Introspect.forSource(src, function(s)
return {
fields = Introspect.publicFields(s),
events = Introspect.events(s),
methods = Introspect.methods(s),
hooks = Introspect.lifecycleHooks(s, lifecycleCatalog),
}
end)
```
## Notes
- Every function is a pure string→table transform: same source text in,
same structured table out, every time. No reads of live component
state, no entity/world queries.
- Structural scanning runs over a comment- and string-aware **mask** of
the source (a same-length copy where comment bodies and string-literal
contents are blanked to spaces, delimiters and newlines preserved).
Pattern matches and brace/paren balancing run on the mask — so a brace,
`Field.`, `Event(`, or a whole entry that appears inside a comment or a
string literal never registers — while captured values are sliced from
the original source at the same (aligned) indices. This makes the
parser robust to apostrophes in comments, commented-out entries, string
defaults containing `}` / `Field.` / `Event(`, and `[[ ]]` long
strings.
- `default` / `category` are raw trimmed source-text slices (with any
trailing comment stripped), not evaluated values.
- For a **ref constructor** (`Field.assetRef` / `dataRef` / `resource`
/ `componentRef`) the FIRST positional argument is the category /
contract / componentType selector, captured under `category`; the
SECOND argument is captured under `default`.
- For every **other** Field kind the first argument is the `default`
and `category` is nil.
- A trailing `Sync` / `NoSync` identifier is captured as `sync`,
tolerating a trailing comma or a trailing comment after the last
argument.
- Field/Event entries whose key is a computed or indirect expression
(`[expr] = Field.number(...)`) are omitted — only literal identifier
keys are recognised.
- `methods` captures a `...` variadic parameter (as `name = "..."`), with
its `: <type>` annotation when present.
- A `--!desc` written above a field/event declaration (`<name> =
Field.<kind>(...)` / `<name> = Event(...)`) or a `public.<name> =`
assignment binds to that name in `docstrings`, and is folded into the
corresponding `publicFields` / `events` entry's `desc`.
- `lifecycleHooks` never hardcodes the lifecycle-callback catalog; the
caller passes the list of names to match against.
- `forSource`'s memo is bounded (oldest-key eviction) so a long session
touching many distinct asset versions can't grow it without limit.
# ik
Look at a rig's bones and at what an IK solve is actually doing.
Debugging IK means answering three questions, and none of them can be answered
from a screenshot: what are this rig's bones called, where are they right now,
and is the chain reaching its target or merely near it.
`bones` lists a body's bones with their world positions and parents — the names
you need before naming a chain, and the positions you measure against when
checking a solve from outside the component. Rigs rarely use the word you would
guess: the standard humanoid here calls its feet `Ankle_L` and `Ankle_R`, with no
bone containing "foot" anywhere.
`reach` reports how far a limb can extend and how far away a point is, both in
the same units. A target beyond a limb's reach has no solution — the chain
extends straight toward it and stops, which is correct and looks exactly like a
broken solver. This is the first thing to check when a solve looks inert.
`state` gathers every IK component on an entity and reports what each one is
doing, so "is anything solving at all" is one call rather than five.
# 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.