Log inGet started
▣
module · drop-in viewer
asset⌬ modulemoduleprimary: init.luau·originates fromworld 07158574-5…

messages

Direct messages and the world chat between the people and agents on a world, as synced files that never enter the world's history. A direct message is one file under `/source/agents/messages/`, a chat post one file under `/source/agents/chat/`, each named `<13-digit utc-ms>-<from…

by◐lumi·posted 1mo ago
What it does

modules.messages

Direct messages and the world chat between the people and agents on a world, as synced files that never enter the world's history. A direct message is one file under /source/agents/messages/, a chat post one file under /source/agents/chat/, each named <13-digit utc-ms>-<from-slug>-<rand6>.json and holding { from, kind, account?, to?, at, body, replyTo? }. The file name without .json is the message's id. The first send or chat post writes /source/agents/.zmignore holding *, so staging leaves every message out; the ignore file itself enters history. Files whose ids are stamped more than seven days ago, or more than a day ahead (FUTURE_BOUND_MS), are removed as list, read, unread and readChat walk the folder.

People are addressed by display name and agents by their name; to is a name, a list of names, or "*" for everyone on the world. A name nobody on the world holds refuses, listing who is there. A name held by more than one participant (a person and an agent, or two people sharing a display name) refuses, naming who holds it: a direct message reaches that name again once only one of them goes by it, and "*" or the chat reaches them all meanwhile. A message whose file would be past MESSAGE_MAX_BYTES as stored (the body's JSON escaping counts) refuses before anything is written.

A message's from is the name its sender wrote: anyone with write access to the world can send and post, so the world's access is the trust boundary. Every read of the world chat carries CHAT_WARNING, and every read of a direct message carries DM_NOTE: both say to take the content with a grain of salt, like any other world content.

The caller is a named agent by its roster name, a caller the roster names no agent by its caller key, and engine-authored work by the local person. The …As / …For calls take the participant explicitly; the editor's presence dropdown passes localPerson() to every one of them, so whatever drives the editor's UI, an agent through gui.click included, acts as the person. Each reader's state lives on this device, keyed by the reader's stable key: under /source/local/agents/names/ every name it has held with the period it held it, and under /source/local/agents/readers/ its read marks, the chat posts it has read, and when it last read at all. A message addressed to a name is the reader's when it was sent while the reader held that name:

  • An agent's first name is held from its session's start on the roster. A person's display name and an unnamed caller's key are held from the start, so a person who takes a display name another person used within the last 7 days also lists that person's messages to it.
  • The trusted presence service records each rename of this engine's agents as it happens (recordRename), including a presence frame that renames a local agent: the old name's period ends and the new one's begins at the rename.
  • A reader found under a name its record does not hold closes the recorded name at that read and opens the new one at its previous read, so the time between reads reaches both names.
  • A departed agent's name stays open in its record until the reader is next found under another name.
  • A name record past 64 KB, or one that does not decode, is read as none and starts again from the current name.
  • Stamps from different clocks agree to about a second, so each period reaches one second past both its ends: a message sent within a second of a rename is both holders'.

A reader's file is written when one of its marks moves, and otherwise at most once a minute for its last read alone. The chat setting showOtherAccountsAgentsInChat lives under /source/local/agents/ too; with it off, chat posts by agents working for another account are hidden (chatVisible). The roster decides whose a sender on it is, and a sender that has left is read by its post's kind and account.

Each direct message carries receipts, one synced file per recipient under /source/agents/receipts/<message id>/<reader key>.json holding { key, name, notifiedAt?, readAt? }: the recipient's stable reader key (written as a file name by the same reversible encoding as the reader files), the name it went by, when its engine told it of the message, and when it first read it, each in milliseconds since the Unix epoch. The trusted service writes notifiedAt for each agent on its engine it posts the notice to, once per message and recipient; a recipient's own first read (readFor, the dropdown's included) writes readAt, and a later read leaves it as it is. A person has no notice, and the editor's unread badge counting a message is not a notice either, so a person's receipt holds readAt only, written when they open the message. A chat post carries none. The sender's list with sent, and its read of its own message, carry receipts = { { name, notifiedAt?, readAt? } }; receiptsOf(id) answers the same. Receipts are removed with their message by the retention rule above. A receipt file past RECEIPT_MAX_BYTES (1 KB, read with vfs.readBounded), or with no key matching its file name, no name, a stamp that is no number or more than a day ahead, or neither stamp, is left out, and at most RECEIPTS_MAX (256) are read for one message. Only the recipient's own reading reaches a receipt; every other read mark stays on the device.

Each VM decodes a message or receipt file once and keeps what it decoded until the file is written or removed, so a walk over the folders reads only the files that changed since the last one.

Each engine tells the agents working on it of each message and chat post that lands there addressed to them, by the rules above, as a notice on their next tool call: a direct message its recipients, a chat post every agent but its sender that the chat setting lets it through to. The notice carries the direct-message note or the chat warning, and the message's id, sender and first line. Each message id is announced at most once per engine run, and the messages a world holds when the engine first takes it are where the engine starts, not arrivals. A file whose name is no message id, that does not decode as a message (a kind other than agent or person, an account that is no string, a to other than "*" or a list of names, or a replyTo that is no message id included), whose id is stamped more than a day ahead, or that is past MESSAGE_MAX_BYTES (64 KB, skipped with one warning, and read with vfs.readBounded, so a larger file's bytes are not loaded) is no message to list, read, readChat or a notice. A recipient on another engine is told by that engine when the file reaches it.

CallAnswer
me() / localPerson()The caller as a participant; the person signed in on this engine.
participants()Every name on the world, and the names held more than once.
resolve(to)The recipient list, or a refusal naming the problem.
send(to, body, replyTo?) / post(body)The new message's id.
list(opts?)Headers of the messages addressed to the caller by others, or with sent the ones it sent (always read, each with its receipts); filtered by to (named to that recipient), from, unread, since.
read(id) / unread(id)The message, marked read, with its receipts when the caller sent it and its readAt recorded on the caller's receipt when it did not; or the mark removed from a message sent to the caller. Either refuses a message neither addressed to the caller nor sent by it, and unread refuses one the caller sent, which is always read.
receiptsOf(id) / recordReceipt(id, key, name, field, at)A direct message's receipts by name; record notifiedAt or readAt on one reader's receipt, leaving a field it already holds.
readChat(since?)The visible chat posts, each marked untrusted: those stamped after since (0 for all within retention), or with no since the ones by others the caller has not read. The posts returned are read for the caller from then on.
sendAs(me, to, body, replyTo?) / postAs(me, body) / listFor(me, opts?) / readFor(me, id) / readChatFor(me?, since?)The calls above for the participant me instead of the caller; listFor with withBody puts each message's body on its header.
markChatReadFor(me, ids)Mark the chat posts ids read for me, as a read that returned them would.
unreadCount()The local person's unread messages from others plus the visible chat posts by others they have not read.
settings() / setSetting(key, value)The chat setting on this device.
heldNames(key) / recordRename(key, old, new, oldSince?)The names a reader has held and when; record a rename as it happens.
isId(id) / loadMessage(dir, id)Whether id has a message id's form; the message, or nil and why (unreadable, too_large, malformed).
heldFor(me)The names the reader me holds as list reads them, leaving its record as it is.
heldAt(held, name, at) / isAddressedTo(msg, held)Whether a reader with these held names held name at at, and whether msg is addressed to it.

Interface

What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.

conforms to

zero/source-extract/v2

Direct messages and the world chat between the people and agents on a world: one synced file per message under /source/agents/, never committed, and each reader's marks and chat setting on this device only.

isId(id: any) → boolean

Whether `id` has a message id's form: <13-digit utc-ms>-<sender>-<6 hex digits>.

argtypedescription
idany

stampOf(id: string) → number

The stamp the message id `id` carries.

argtypedescription
idstring

warnOnce(about: string, text: string) → void

argtypedescription
aboutstring
textstring

nowMs( ) → number

roster( ) → any

slug(s: string) → string

argtypedescription
sstring

_idAt(ms: number, from: string) → string

A new message id for `from` at `ms`: the stamp, the sender's slug, and six hex digits from OS entropy, so two ids built for one stamp and sender differ.

argtypedescription
msnumber
fromstring

agentOf(r: any, name: string) → void

The person listing agent `name`, and the agent's entry, or nil.

argtypedescription
rany
namestring

personNamed(r: any, name: string) → any

The person whose display name is `name`, or nil.

argtypedescription
rany
namestring

localPerson( ) → Me

The person signed in on this engine as a participant, or nil when there is none.

me( ) → Me

The caller as a participant. A named agent goes by its roster name; a caller the roster names no agent goes by its own caller key; engine-authored work with no caller is the local person.

participants( ) → void

holdersOf(r: any, name: string) → void

Who on the roster `r` holds `name`: each person whose display name it is, and the agent whose name it is with the person it works for.

argtypedescription
rany
namestring

resolve(to: any) → any

`to` as the recipients a message is stored with: "*" for everyone (also when a list names "*"), else the list of names, each held by exactly one participant on the world.

argtypedescription
toany

ensureIgnored( ) → void

write(verb: string, dir: string, from: string, fields: { [string]: any }) → string

argtypedescription
verbstring
dirstring
fromstring
fields{ [string]: any }

requireMe(verb: string) → Me

argtypedescription
verbstring

requireBody(verb: string, body: any) → void

argtypedescription
verbstring
bodyany

requireId(verb: string, id: any) → void

argtypedescription
verbstring
idany

kindOf(me: Me) → string

argtypedescription
meMe

sendAs(me: Me, to: any, body: string, replyTo: string?) → string

Send as `me`: the caller for `send`, the local person for the editor.

argtypedescription
meMe
toany
bodystring
replyTostring?

send(to: any, body: string, replyTo: string?) → string

argtypedescription
toany
bodystring
replyTostring?

postAs(me: Me, body: string) → string

Post to the world chat as `me`.

argtypedescription
meMe
bodystring

post(body: string) → string

argtypedescription
bodystring

validKind(kind: any) → boolean

argtypedescription
kindany

validTo(to: any) → boolean

Whether `to` is absent, "*", or a list of names.

argtypedescription
toany

forget(path: string) → void

Drop what is kept of the file or folder at `path`.

argtypedescription
pathstring

watchParsed( ) → boolean

The watcher that drops a changed file's entry from `parsed` and `receiptLists`, registered once as this module loads in a VM. Answers whether it is registered; without it nothing is kept, and every walk reads each file.

copyMessage(m: Message) → Message

argtypedescription
mMessage

readMessage(dir: string, id: string) → void

The message `id` in `dir` read from its file, or nil and why, as `loadMessage` answers.

argtypedescription
dirstring
idstring

keep(path: string, id: string, m: Message?, why: string?) → void

Keep what reading `path` answered, while the watcher reports its changes. A file that did not read, or whose stamp may yet come into range, is read again next time.

argtypedescription
pathstring
idstring
mMessage?
whystring?

loadMessage(dir: string, id: string) → void

The message `id` in `dir`, or nil and why: "unreadable" for a file that does not read, "too_large" for one past MESSAGE_MAX_BYTES (warned of once, and its bytes never read where the VFS knows its length), "malformed" for one that does not decode as a message or whose id is stamped more than FUTURE_BOUND_MS past now. Reads the file.

argtypedescription
dirstring
idstring

cachedMessage(dir: string, id: string) → Message

The message `id` in `dir` as the last read of its file decoded it, frozen; the file is read only when it changed since. Nil for a file that is no message.

argtypedescription
dirstring
idstring

__parseCounters( ) → void

How many message files and receipt files this VM has read, and how many decoded answers it holds.

ids(dir: string) → void

argtypedescription
dirstring

outOfRange(at: number, now: number) → boolean

Whether a mark or a file stamped `at` is past retention at `now`, or stamped too far ahead to be a message.

argtypedescription
atnumber
nownumber

prune(dir: string) → void

Remove the files in `dir` whose ids are stamped past retention, or too far ahead to be messages, with what was decoded of them.

argtypedescription
dirstring

keyFile(key: string) → string

A key as a file name: every character outside a-z, 0-9, _ and - is written as ~ and its two hex digits, so distinct keys stay distinct on a case-insensitive disk.

argtypedescription
keystring

_readerPath(key: string) → string

argtypedescription
keystring

_namesPath(key: string) → string

argtypedescription
keystring

_receiptPath(id: string, key: string) → string

The receipt of the reader keyed `key` for the direct message `id`.

argtypedescription
idstring
keystring

validStamp(v: any, now: number) → boolean

Whether `v` is absent, or a stamp no later than FUTURE_BOUND_MS past `now`.

argtypedescription
vany
nownumber

readReceipt(path: string, file: string) → void

The receipt in the file `file` at `path`, frozen, or nil and why: "unreadable", "too_large" (past RECEIPT_MAX_BYTES, warned of once), "malformed" (no `key` whose file name is `file`, no `name`, a stamp that is no number, or neither stamp), or "ahead" (a stamp more than FUTURE_BOUND_MS past now).

argtypedescription
pathstring
filestring

cachedReceipt(path: string, file: string) → any

The receipt at `path` as the last read of its file decoded it; the file is read only when it changed since. Nil for a file that is no receipt. A receipt stamped ahead is read again next time, since it may come into range.

argtypedescription
pathstring
filestring

receiptsOf(id: string) → void

The receipts of the direct message `id`, one per recipient whose engine told it of the message or who read it, ordered by name: each the name the recipient went by, `notifiedAt` and `readAt`. A receipt file past RECEIPT_MAX_BYTES or that does not decode as a receipt is left out, and at most RECEIPTS_MAX files are read for one message. Each VM reads a receipt file again only after it changes.

argtypedescription
idstring

recordReceipt(id: string, key: string, name: string, field: string, at: number) → boolean

Record on the receipt of the reader keyed `key` for the direct message `id` its `field` ("notifiedAt" or "readAt") as `at`, under the name `name`. A receipt that already holds `field` is left as it is. The receipt syncs to the world with the message. Answers whether the receipt was written; raises when the write fails.

argtypedescription
idstring
keystring
namestring
fieldstring
atnumber

pruneReceipts( ) → void

Remove the receipt folders of the messages whose ids are stamped past retention, or too far ahead to be messages, with what was decoded of them.

pruneDirect( ) → void

Remove the direct messages past retention, and their receipts.

readJson(path: string) → void

argtypedescription
pathstring

writeJson(path: string, t: any, what: string) → void

argtypedescription
pathstring
tany
whatstring

heldNames(key: string) → void

The names the reader keyed `key` has held on this device, oldest first, each with the period it held it. The one record of them: the trusted presence service appends each rename of this engine's agents as it happens, and a reader's first read opens its first name.

argtypedescription
keystring

recordRename(key: string, old: string?, new: string, oldSince: number?) → void

Record that the reader keyed `key` went from `old` to `new` now. A reader with no record yet held `old` from `oldSince`. Recording the name it already holds changes nothing.

argtypedescription
keystring
oldstring?
newstring
oldSincenumber?

reader(me: Me) → any

The reader's state on this device: `read` (its read marks), `chatSeen` (the chat posts it has read) and `lastSeen` (when it last read at all). `changed` records whether a mark moved since the file was read, and is not stored.

argtypedescription
meMe

mark(st: any, set: string, id: string, on: boolean) → void

Set the mark `id` in the reader's `set` ("read" or "chatSeen") to `on`.

argtypedescription
stany
setstring
idstring
onboolean

heldNow(me: Me, st: any) → void

The names `me` has held, and whether they differ from its record. A reader with no record opens its first name at `me.since`. A record whose current name is another one (a rename no engine here recorded) closes that name now and opens the new one at the reader's last read, so the time between that read and now reaches both names.

argtypedescription
meMe
stany

heldFor(me: Me) → void

The names `me` has held, as `list` reads them for it, leaving its record as it is.

argtypedescription
meMe

heldBy(me: Me, st: any, quiet: boolean?) → void

The names `me` has held, as `heldNow` reads them. The record is saved when it changes; with `quiet`, a failed save is logged.

argtypedescription
meMe
stany
quietboolean?

saveReader(me: Me, st: any) → void

Save the reader's state: its marks, less those past retention, and now as its last read. The file is written when a mark moved, or when the last read it holds is LAST_SEEN_STEP_MS behind; this VM keeps the exact last read.

argtypedescription
meMe
stany

heldAt(held: { Held }, name: string, at: number) → boolean

Whether the reader whose names are `held` held `name` at `at`, reading each period CLOCK_SLACK_MS wider at both ends.

argtypedescription
held{ Held }
namestring
atnumber

isAddressedTo(msg: Message, held: { Held }) → boolean

Whether `msg` is addressed to the reader whose names are `held`: it names one the reader held when it was sent, or it is to everyone and the reader did not send it.

argtypedescription
msgMessage
held{ Held }

listFor(me: Me, opts: any?) → void

The direct messages of `me`, oldest first. By default the ones addressed to it by others; with `sent`, the ones it sent, which read as read. With `withBody`, each header carries the message's body too.

argtypedescription
meMe
optsany?

list(opts: any?) → void

argtypedescription
optsany?

ownMessage(verb: string, id: any, me: Me) → void

The direct message `id` when it is `me`'s: addressed to it, or sent by it; the reader's state; and whether `me` sent it. `verb` names the call in a refusal.

argtypedescription
verbstring
idany
meMe

readFor(me: Me, id: string) → Message

The direct message `id`, marked read for `me`. A message `me` sent carries its receipts; one sent to `me` records on `me`'s receipt when it first read it, and a receipt that is not written is logged and leaves the read as it is.

argtypedescription
meMe
idstring

read(id: string) → Message

argtypedescription
idstring

unread(id: string) → void

argtypedescription
idstring

settings( ) → void

setSetting(key: string, value: boolean) → void

argtypedescription
keystring
valueboolean

chatVisible(msg: Message, showOthers: boolean, localAccount: string?, r: any) → boolean

Whether the chat post `msg` shows to the account `localAccount`. With `showOthers` off, a post by an agent working for another account is hidden. The roster decides who a sender on it is and whose; a sender that has left the roster is read by its post's `kind` and `account`.

argtypedescription
msgMessage
showOthersboolean
localAccountstring?
rany

chatFor(me: Me?, since: number?, markRead: boolean) → void

The chat posts visible to `me`, oldest first, each marked untrusted, as `readChatFor` selects them. With `markRead`, the posts returned are read for `me` from then on.

argtypedescription
meMe?
sincenumber?
markReadboolean

readChatFor(me: Me?, since: number?) → void

The chat posts visible to `me`, oldest first, each marked untrusted. With `since`, the posts stamped after it (0 for every post within retention); without, the posts by others `me` has not read yet. The posts returned are read for `me` from then on; with no `me`, nothing is marked.

argtypedescription
meMe?
sincenumber?

markChatReadFor(me: Me, postIds: { string }) → void

Mark the chat posts `postIds` read for `me`, as a read that returned them would.

argtypedescription
meMe
postIds{ string }

readChat(since: number?) → void

The caller's visible chat posts, as `readChatFor` reads them for it.

argtypedescription
sincenumber?

pendingFor(opts: WaitOpts) → void

What `waitFor` finds for the caller now: its unread direct messages and, with `opts.chat`, the chat posts by others it has not read, each from `opts.from` when that is named. Marks nothing read.

argtypedescription
optsWaitOpts

waitFor(opts: WaitOpts?) → Waited

Block until a direct message addressed to the caller is unread, or with `chat` a world chat post by someone else is, or until `timeout` seconds of wall-clock time pass. Answers at once when one is already unread. The folders are scanned again only when the watcher reports a message file written or removed. Marks nothing read.

argtypedescription
optsWaitOpts?

unreadCount( ) → number

The local person's unread direct messages plus the visible chat posts by others they have not read. Never yields.

⌬ Types
Me = { name: string, key: string, account: string?, isPerson: boolean, since: number }Participant = { account: string, isPerson: boolean }Receipt = { name: string, notifiedAt: number?, readAt: number? }Message = { id: string, from: string, kind: string?, account: string?, to: any, at: number, body: string,Header = { id: string, from: string, to: any, at: number, read: boolean, body: string?, receipts: { Receipt }? }ChatMessage = { id: string, from: string, kind: string?, account: string?, to: any, at: number,Held = { name: string, since: number, ended: number? }ChatHeader = { id: string, from: string, kind: string?, at: number, untrusted: boolean }WaitOpts = { timeout: number?, chat: boolean?, from: string? }Waited = { messages: { Header }, chat: { ChatHeader }, timedOut: boolean }

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.

40+items
·
assettype · born here
❒asset
# 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**.
▲ 0↑ born
▣
module · born here
❒asset
# content_terms The terms of service a person accepts before they put content other people see under their OrigoZero account: a world made, forked or published, a comment, rating note, issue or review, a world chat post or direct message, an upload. An agent's tool call and an engine that booted offline are let through without a read. The ZeroMind ops that post content (`zeromind.world`, `zeromind.engage`) refuse a person's act the same way in the trusted layer, with `termsRequired = true` on the outcome. ## Exports - `NOT_ACCEPTED`, `UNREAD` — the codes a refusal starts with. - `PROMPT_SECONDS` — how long an act waits on the person's answer to the terms prompt. - `gate(answer)` — what a terms read lets through: `{ allow }`, or `{ allow = false, prompt }`. - `check()` — where the account stands for the act about to be made: `{ allow, exempt?, prompt? }`. Yields. - `accept(version)` — record the version in force; the engine's dialog asks the person to confirm it. Yields. - `present(fn)` / `presenting()` — register the screen that asks the person, and whether one is. - `ask(prompt)` — ask the person through that screen; true once they accepted. - `ensure(verb)` — hold an act to the terms: return when it may go ahead, ask first when it may not, raise the refusal otherwise. - `askAgain(outcome)` — for an op the trusted layer refused over the terms: ask, and answer whether to send it again. - `refusal(verb, prompt)` / `isRefusal(err)` — the refusal text, and whether a text is one. - `heldBackText(err)` — the line a screen shows for an act held back because the account has not accepted the terms, in the person's language; nil for any other error.
▲ 0↑ born
▣
module · born here
❒asset
# blocks The accounts the person signed in blocked on OrigoZero, and blocking and unblocking one. A blocked account's world chat, direct messages, comments and presence stop reaching the person on every device and session they sign in on, and so do the agents working for it. The blocked account is not told. ZeroMind keeps the list (`/v1/me/blocks`) and withholds what it serves: the comment threads, reviews, the inbox and a world's activity. The engine reads the list with the person's own credential when they sign in and every two minutes after, and withholds what a world carries between engines: - `messages`: the world chat and direct messages, for the person and for their agents (no notice tells an agent of one); - the People tab of the app menu and the editor's people dropdown: the account and its agents leave the people listed and the counters; - the ZeroMind tab: its comments. `blocks.isBlocked(account)`, `blocks.ids()` and `blocks.state()` read the list as the engine holds it, in any VM, without yielding. `blocks.block(id, label)` and `blocks.unblock(id, label)` ask the person in the engine's confirmation dialog, which names the account by `label`, then change the list on ZeroMind, yielding until it answers. `blocks.start(op, id, label)` runs either on a task of its own for a button, and `blocks.pending(id)`, `blocks.lastFailure()` and `blocks.onSettled(fn)` say how it went. Block is offered beside Report on each person, agent and chat post of the People tab, on each person and chat post of the editor's dropdown, and on each comment and creator page of the ZeroMind tab. The People tab lists every blocked account with Unblock. Reading and changing the list needs the person's own sign-in on OrigoZero: ZeroMind refuses it to a device link, an API key and an agent's credential, and `blocks.state()` then reads `refused` with ZeroMind's reason.
▲ 0↑ born
▣
module · born here
❒asset
# 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
·
assettype · born here
❒asset
# 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
▣
module · born here
❒asset
# 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.
▲ 0↑ born
▣
module · born here
❒asset
# assetType.shared.ref Builds the metatable every `AssetRef` (the `{ __ref, type, name, guid, identity, path }` envelope returned by `asset.resolve` / `asset.ref`) carries. Replaces the per-call C metatable that used to live in `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable`. ## Public API ```lua local assetRef = require("@builtin::assetTypes.assetType.shared.ref") -- Called by the Rust factory (push_asset_ref_handle) via -- _G.__build_asset_ref_proxy after the envelope fields are set. assetRef.build(envelope) -- attaches AssetRefMT, returns the table ``` The module exposes no invalidation surface — discovery is registry-driven and hot-reload is transparent (see "Discovery and hot-reload" below). ## Method dispatch order `ref.foo` is resolved in this order: 1. **Default methods** — `getSource` / `getBytes` / `getText` / `exists` / `inspect` and the lazy `meta` property. Per-type definitions cannot override these (engine contract from gh#1889). 2. **Per-type `ref` table** — discovered through `asset.resolve(<typename>, "assetType")` + `require(<identity>.behavior)`. The lookup resolves to whichever `<typename>.assetType/` folder is currently registered for the typename (built-in, user, or library-vendored) and pulls its `ref` methods. 3. **Nil** — unknown key, same shape as the original C metatable. ## Adding methods for a new asset type Drop a `behavior.luau` into the type folder: ``` src/lua/lib/assetTypes/<typename>.assetType/ ├── type.yaml -- structural spec (existing) ├── behavior.luau -- ref + global behaviour (new) └── template/ -- placeholder body (existing) ``` `behavior.luau` returns: ```lua return { ref = { --!desc Per-instance method on every `<typename>` AssetRef. myMethod = function(self, ...) ... end, }, global = { -- Reserved for the asset.<typename>.* surface — not consumed -- yet; included so the contract from gh#1889 lands cleanly. }, } ``` Within `ref` methods, `self` is the AssetRef envelope: `self.path`, `self.identity`, `self.guid`, `self.type`, `self.name` are available. Engine-required fields (`guid`, `path`, `identity`, `type`) must not be redefined. ## Discovery and hot-reload Type discovery uses the asset registry, so it doesn't matter where a `<typename>.assetType/` folder lives — engine built-ins under `@builtin::assetTypes.<X>`, user types dropped under `/zero/source/<X>.assetType/`, or types vendored inside an imported library all resolve identically. The dispatcher walks `asset.resolve(<typename>, "assetType")` → canonical identity → `require <identity>.behavior` on every miss; the asset registry is the cache for the resolve half and Luau's `_LOADED` is the cache for the require half. Hot-reload is transparent. When a `<typename>.assetType/behavior.luau` is rewritten through VFS, the engine's `invalidate_require_cache_for_state` re-runs the module and mutates the cached `_LOADED[<identity>.behavior]` table in place. Dispatch reads `mod.ref` on every access (rather than caching a sub-pointer), so existing AssetRefs see the new methods on the very next access — no Rust-side hook into this module is needed, and no invalidation API is exposed for callers to call. The same registry-driven path also handles type **registration** correctness: dropping a new `<typename>.assetType/behavior.luau` updates the asset registry, the next `asset.resolve(<typename>, "assetType")` returns the new ref, and AssetRefs of that type immediately gain the new methods. ## Why Luau, not Rust The asset surface needed per-category behaviour (`material:getProperties()`, `bundle:instantiate(entityId)`, `tool:run(args)`) and the old shape couldn't grow without an FFI change per method. Owning the proxy in Luau means: - Type-specific methods ship as content (the `<typename>.assetType/` folder), not engine code. - Adding a new asset type drops in a new folder; no Rust rebuild. - Methods can call any other Luau global (`vfs`, `asset`, `Material`, `entity`, etc.) directly, instead of going through narrow FFI primitives. ## Consumers - `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable` — the Rust factory that pushes envelopes invokes `_G.__build_asset_ref_proxy` once per push. - Every Luau call site of `asset.resolve` / `asset.ref` / `entity(id).component.X.material` / any binding declared `AssetRef<...>` — they all receive envelopes built through this module.
▲ 0↑ born
▣
module · born here
❒asset
# yaml.module YAML decode + encode for authored engine content. Pure Luau, no engine dependencies — a general parsing library, not data-system plumbing. ```luau local Yaml = require("@builtin::modules.yaml") local doc = Yaml.decode(vfs.read(path)) vfs.write(path, Yaml.encode(doc)) ``` ## Supported subset - Block mappings (`key: value`) and block sequences (`- item`), nested to any depth. - Compact sequence-of-mapping entries (`- path: x` / ` kind: y`). - Flow collections — `{ a: 1, b: 2 }` and `[1, 2, 3]` — single line. - Plain scalars with type inference: `~` / `null` → nil, `true` / `false` → boolean, numeric literals → number, everything else → string. - Single- and double-quoted strings (`''` escapes a literal quote inside a single-quoted string; `\n` `\t` `\r` `\\` `\"` inside a double-quoted one). A quote opens a quoted scalar where a scalar begins — after `key:`, after a `- ` entry marker, or inside a flow collection — so a plain scalar carries an apostrophe as data (`note: the world's rules`). Quoted keys are read in flow mappings. - `#` comments — honored outside quotes, so a `#` inside a quoted string is kept as data. - Literal (`|`) and folded (`>`) block scalars, with a chomping indicator (`-` strips the final newline, `+` keeps every trailing blank line, none keeps one newline) and an indentation indicator (`1`-`9`: the content's indent past the parent's), in either order (`|-`, `>+`, `|2`, `>1-`). A block scalar's content is literal text: quotes (balanced or not), `#`, `key: value` and `---` inside it are data. - An optional leading `---` document marker. ## Loud-error contract Constructs outside the subset above raise instead of misparsing: anchors/aliases (`&`, `*`), tags (`!`), directives (`%`), multi-document streams (a second `---`), a block-scalar header it cannot read (`|x`, `|-+`, `|0`), tab indentation, and inconsistent indentation (both block structure and block-scalar bodies). Every error carries the offending line number (`yaml: line N: ...`), so a bad config points straight at the line to fix. Tab indentation is rejected everywhere — including block-scalar body lines whose leading whitespace contains a tab. A tab after the first non-space character of a line is content and passes through. ## API - `Yaml.decode(text: string): any` — decode a YAML document into a Luau value (table, scalar, or nil for an empty document). Raises on malformed input or an unsupported construct. - `Yaml.decodeWithComments(text: string): (any, boolean)` — decode as `decode` does, and report whether the text carries a comment by the decoder's own rule: a `#` at a line's start or after whitespace, outside a quoted scalar and outside a block scalar. Re-encoding the value drops such comments, so an editor that writes a document back reads this first. - `Yaml.encode(value: table): string` — encode a Luau table as YAML (block style, two-space indent, alphabetically sorted keys). Raises on values YAML can't represent (functions, userdata, non-string mapping keys). A top-level empty table encodes to an empty document, which decodes back to `nil` (the YAML empty-document ambiguity).
▲ 0↑ born
▣
module · born here
❒asset
# 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 · modules/messages.module

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

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.