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

vfs

Public Luau surface over the `__vfs` Internal FFI namespace — the engine's virtual filesystem.

byzero-proxy @ DESKTOP-DB3UJOJ·posted 4mo ago
What it does

vfs Module

Public Luau surface over the __vfs Internal FFI namespace — the engine's virtual filesystem.

Purpose

Wrap the raw __vfs.* FFI namespace in a typed Luau table that gets auto-injected as _G.vfs via the prelude. The standard read / write / move / remove / mkdir / list / exists / readAsync / reload / evict surface, plus trusted-only watch / unwatch for the bootstrap VM.

vfs.read yields on a byte-cache miss: the module's last step installs the vfs_async_read fallback over the synchronous read, so every VM that holds this namespace, the trusted VM included, reads a path through the same two steps and gets the same bytes for it.

Usage

-- Read / write
local src = vfs.read("@builtin/components/Camera.luau")
vfs.write("/zero/source/notes.md", body)

-- What a write landed: where the bytes went, and what the static passes
-- read in the Luau among them
local ok, report = vfs.write("/zero/source/game/Vent.component/init.luau", code)
if report.diagnostics then
    for _, d in report.diagnostics do
        print(d.severity, d.path, d.line, d.message)
    end
end
if not report.durable then
    log.warn(report.warning)
end

-- Listing
for _, e in ipairs(vfs.list("/zero/source")) do
    print(e.isDirectory and "[d] " or "    ", e.name)
end

-- Async fetch
local png = task.await(vfs.readAsync("/zero/runtime/screenshots/last.png"))

-- Reclaim RAM after processing a big binary
vfs.evict("/zero/source/textures/imported_huge.png")

-- Reload a module after editing its source on disk
if vfs.reload("@mylib/utils.helpers") then
    local m = require("@mylib/utils.helpers")  -- sees the new source
end

vfs.reload(identity) answers whether a module was cached under that name and has now been dropped. A false says the name matched nothing — either a misspelled identity or a module this VM never required — so the next require() returns whatever it would have returned anyway.

A module that caches state derived from OTHER files keeps serving the old value when those files are rewritten, since only its own source is watched. Reload it by identity to make the next require() recompute.

How a write reaches disk

A native engine's vfs.write returns once the engine holds the bytes. The blob a binary write stores by content and the journal record of the mutation are written by a worker thread (vfs-io) in the order the writes were made, so the blob is on disk before the record that names it, and a script that writes a thousand files pays for handing them over, not for the flush of each. A read of a blob still waiting for its file answers from memory, so a write reads back the moment it returns. A queue holding more than its byte budget (256 MiB) makes the next write wait for it and write inline, which bounds the memory the queue pins. The queue is flushed when the engine exits normally; a process killed in the milliseconds between a write and its flush loses that write. world.syncStatus() reports nothing owed once the writes have also reached the world.

Exports

  • vfs.read(path, opts?) -> string?
  • vfs.write(path, content, opts?) -> (boolean, WriteReport | string)
  • vfs.move(src, dst, opts?) -> (boolean, WriteReport | string)
  • vfs.copy(src, dst) -> (boolean, WriteReport | string)
  • vfs.remove(path, opts?) -> (boolean, string?)
  • vfs.mkdir(path, opts?) -> boolean
  • vfs.list(path?) -> { VfsListEntry }
  • vfs.exists(path, opts?) -> boolean
  • vfs.readAsync(path, opts?) -> promiseId
  • vfs.reload(modulePath?) -> boolean
  • vfs.evict(path, opts?) -> boolean
  • vfs.mutationSeq() -> number
  • Trusted-only: vfs.watch(path, callback) -> number / vfs.unwatch(watcherId) -> boolean.

Interface

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

conforms to

zero/source-extract/v2

global vfs global-types module vfs Virtual filesystem — read, write, list, watch. Public Luau surface over the `__vfs` Internal FFI namespace. require modules/api/engine/vfs about A write to authored `/source` WHILE PLAY IS RUNNING lands on the play shadow: the bytes are live in the session immediately, and a guarded play-exit puts the pre-play copy back unless they were kept. A restart ends it. In a play room a write a call makes reaches every client in the room (a session write): its report carries `session` and `writer`, and its `warning` opens with `PLAY SESSION`. `vfs.durability(path)` answers where any write's bytes went: `durable`, whether a restart keeps them in `survivesRestart`, the state in `warning`, the routes out in `playShadow`, and which of the paths you asked about the shadow holds in `shadowed`. `vfs.playShadowPaths()` lists the edits this client's own calls made and `vfs.playShadowAuthors()` says whose each one is; the edits other clients of the play room sent here are `vfs.playShadowReceived()`. Three routes keep a write, differing in what they cost the session: vfs.promotePlayShadow(path) -- or a list of paths: THOSE -- paths onto canonical source, -- play keeps running, the rest -- of the set untouched vfs.write(path, bytes, { durable = true }) -- the write skips the -- shadow, nothing to promote tools.use("sceneAuthoring", "changes") -- then acceptChanges: reaches -- ENTITY changes too, the -- session keeps running `vfs.revertPlayShadow` takes the same path or list and does the opposite. A folder asset settles whole: a path carrying an asset-type suffix names the asset, so one `.component` write shadows its entry file, its README and its metadata together, and promoting or reverting any one of them settles all three, naming each in its second return value. A play-exit refuses over whatever is still shadowed; `vfs.playShadowPaths()` lists it. The `core/vfs` guide has the model and what each route costs.

bumpVersion(path: string) → void

Bump a path's content-version counter so any assetType behavior that memoized a parse of that file (keyed by `content_version.get`) rebuilds on its next read — SYNCHRONOUSLY, in the same tick as the write, which the deferred asset-change `onChange` dispatch can't guarantee. Lazy-required so this module (installed early in the prelude) carries no load-order dependency on it; the module has no dependencies of its own, so the first call resolves cleanly.

argtypedescription
pathstring

bumpCopied(src: string, dst: string) → void

Bump every path a copy of `src` landed under `dst`. A leaf lands one path; a folder lands one per descendant, at the same relative position under `dst`. The walk follows the SOURCE, so the bumped set is exactly the set whose bytes the copy replaced — a file already sitting beside the destination keeps its counter, and the work is bounded by what was copied.

argtypedescription
srcstring
dststring

read(path: string, opts: VfsOpts?) →

Read a file from the virtual filesystem. Binary-safe. Returns file contents as a string. A read that finds no bytes the text the `read_file` tool and the VFS HTTP route give for the same path (`/zero/source/a.txt: not found`, a directory's refusal, a `/runtime` node's account of what it holds). Handed straight to another call, the read passes that reason on as the next argument too; wrap it in parentheses, `Json.decode((vfs.read(path)))`, to pass the bytes alone. Relative paths resolve under `opts.root` (default `/source/`). When the bytes aren't locally cached and the calling code can yield (`coroutine.isyieldable()`: a task, `awake`, `start`, `update`, `onEnable`, `onOwnerChanged`, `onSyncReceived`, a replicated event's handler), the read waits while the lazy fetch runs and answers the bytes. Code that cannot yield (`onDisable`, `onDestroy`, `onPropertyChanged`, a received synced-function call, a `vfs.watch` callback, a module's top level while `require` runs it, a metamethod, a `table.sort` comparator) cannot wait: a read there of bytes still on their way (a file `vfs.exists` knows, a render surface being captured, a `/runtime/sync` node whose current reading the next frame assembles) raises `VFS_READ_CANNOT_WAIT`, naming the path and where to read it. holds no bytes to read) for a read that finds none.

argtypedescription
pathstringVFS path.
optsVfsOpts?`{ root = "/source/" }`.

examples

local src, why = vfs.read("/zero/source/notes.txt"); if src == nil then print(why) end

readBounded(path: string, maxBytes: number) →

Read a file from the virtual filesystem, at most `maxBytes` long. Binary-safe, and read the way `vfs.read` reads it. A file longer than `maxBytes` answers `nil, "too_large"`; where the layer holding it states its length (a file held in memory, a synced or staged file) its bytes are never read. Relative paths resolve under `/source/`. Where the calling code can yield, a file whose bytes are not cached is fetched and held to the same bound; where it cannot, a known file whose bytes have not arrived raises `VFS_READ_CANNOT_WAIT`, as `vfs.read` does. A read that finds no bytes answers nil and the reason `vfs.read` gives. longer than `maxBytes`; nil and the reason `vfs.read` gives for a read that finds no bytes.

argtypedescription
pathstringVFS path.
maxBytesnumberThe most bytes the read answers, a whole number 0 or more.

examples

local raw, why = vfs.readBounded("/zero/source/notes.json", 65536)

write(path: string, content: string, opts: VfsOpts?) →

Write content to a file. Binary-safe. Overwrites existing files by default — pass `opts.overwrite = false` to refuse to clobber. While play is running a `/source` write lands on the play shadow: it succeeds and reads back, live in the session, and is undone by a guarded play-exit unless accepted; the report's `survivesRestart` says whether a restart keeps it. Scratch under `/source/tmp/` writes through untouched, in edit mode and in play, and is gone when the engine stops or restarts, so its report says `durable = false`, `survivesRestart = false` and a `warning` opening `SCRATCH`. Pass `opts.durable = true` to say these bytes ARE the source: the write reaches canonical `/source` with play still running and the session still in play, hot-reloading the modules and components that read it, so the edit is observed running in the same play session with nothing left to promote. A durable write RAISES with the reason when the bytes cannot become canonical source. One write carries at most 256 MiB: longer content RAISES, naming its size and that limit, and the path keeps what it held. went, with `survivesRestart` / `warning` / `playShadow` / `shadowed` beside it when the play shadow took them and `survivesRestart` / `warning` / `scratch` when they landed in `/source/tmp/` scratch, `diagnostics` carries what the static passes read in the Luau it landed, and `contentRequirements` names what the asset it landed in must still say before the world publishes. It is the answer the MCP `write_file` tool gives for the same bytes at the same path. On failure returns false + error message; a durable write, and content past 256 MiB, raise instead of returning false.

argtypedescription
pathstringVFS path to write to.
contentstringFile content (binary-safe).
optsVfsOpts?`{ root = "/source/", overwrite = true, quiet = false, durable = false }`.

examples

vfs.write("/zero/source/notes.md", body)
local ok, report = vfs.write("/zero/source/game/Vent.component/init.luau", src)
if report.diagnostics then for _, d in report.diagnostics do print(d.severity, d.path, d.line, d.message) end end
if report.contentRequirements then for _, r in report.contentRequirements do print(r.path, r.detail) end end
if not report.durable then log.warn(report.warning) end
vfs.write("/zero/source/game/Vent.component/init.luau", src, { durable = true })

move(src: string, dst: string, opts: { quiet: boolean? }?) →

Move a file from `src` to `dst`. By default fires the destination's write side effects; pass `opts.quiet = true` to suppress them. A quiet move still returns the destination's report and still posts the resolve rule the publish gate reads, which is what `vfs.write` does with the same option: a publish takes no override, so the finding is stated at the line that carries it. While play is running a move takes the source away, so authored `/source` content that predates play is refused and the refusal RAISES with the reason; content this play session created moves and stays tracked on the play shadow. destination, so it reports what `vfs.write` reports for the same bytes at that path: where they went, and what the static passes read in the Luau among them, per landed leaf when the move took a folder. (false, errmsg) when the paths themselves refuse it. A move the running play session refuses raises with the whole reason instead.

argtypedescription
srcstringSource absolute VFS path.
dststringDestination absolute VFS path.
opts{ quiet: boolean? }?Optional `{ quiet: boolean? }`.

examples

vfs.move("/zero/source/a.luau", "/zero/source/b.luau")
local ok, report = vfs.move(mod .. "/init.luau", comp .. "/init.luau")

copy(src: string, dst: string) →

Copy a file OR directory from `src` to `dst`, `cp -r` style. A directory recurses — every descendant is replicated at the same relative path under `dst`, `.refs` sidecars included. `.meta` sidecars are minted fresh, so a copy is a distinct asset with its own identity. Both paths are absolute. The source may live in any layer (writable, library mount, builtin, runtime-generated); the destination must be a writable route. destination, so it reports what `vfs.write` reports for the same bytes at that path: where they went, and what the static passes read in the Luau among them, per landed leaf when the copy took a folder. A module that is advisory where it sat reads as a script error once it sits on a component path, and the copy is what put it there. (false, errmsg) on failure.

argtypedescription
srcstringSource absolute VFS path (file or directory).
dststringDestination absolute VFS path.

examples

vfs.copy("/zero/runtime/recordings/take1.mp4", "/zero/source/clips/take1.mp4")
local ok, report = vfs.copy(mod, "/zero/source/game/Vent.component")

remove(path: string, opts: VfsOpts?) →

Remove a file. Refuses to remove directories unless `opts.recursive = true`. Refuses protected system roots. While play is running, authored `/source` content that predates play is refused and the refusal RAISES with the reason; content this play session created is removable, a folder included. Pass `opts.durable = true` to say the removal IS a change to the source: it takes the route edit mode takes with play still running and the session still in play, the counterpart of `vfs.write(path, bytes, { durable = true })` for taking a path away rather than replacing its bytes. Every other refusal stands in either terms — a protected root, a read-only route, a plain directory without `recursive`. the removal. A removal the running play session refuses raises with the whole reason instead, so a `pcall` around the call reads it — and the lock answers ahead of whether the path is there, so a locked `/source` path raises whether or not it holds anything.

argtypedescription
pathstringVFS path to remove.
optsVfsOpts?`{ root = "/source/", recursive = false, durable = false }`.

examples

vfs.remove("/zero/source/scratch.luau")

mkdir(path: string, opts: VfsOpts?) → boolean

Create a directory. `mkdir -p` semantics — idempotent. Errors if a file already exists at the same path. While play is running an authored `/source` directory waits for the lock to lift and the refusal RAISES with the reason; writing a file under the path creates it as part of that write, and scratch under `/source/tmp/` creates as in edit mode. running play session refuses raises with the whole reason.

argtypedescription
pathstringDirectory path.
optsVfsOpts?`{ root = "/source/" }`.

examples

vfs.mkdir("/zero/source/scenes/")

list(path: string?) →

List entries in a VFS directory. A directory whose current listing the next frame assembles (`/zero/runtime/sync/entities` after a stretch nothing read the replication surface) is waited for where the calling code can yield (`coroutine.isyieldable()`), as `vfs.read` waits; where it cannot, the listing raises `VFS_READ_CANNOT_WAIT`, naming the path. gives an entry's size and modification time.

argtypedescription
pathstring?Directory path (defaults to `/zero`).

examples

for _, e in ipairs(vfs.list("/zero/source")) do print(e.name) end

isDirectory(path: string, opts: VfsOpts?) → boolean

Is ONE path a directory? Answers from reality — the writable layer's children, a resolver-served folder listing, an explicit empty-directory marker — so a loose file whose extension collides with an assetType name (`notes.json`) reads as the file it is while a real `<name>.<type>/` folder reads as a folder. Costs the same whatever the containing folder holds; use `vfs.list` when you want every entry's kind, this when you hold one path.

argtypedescription
pathstringVFS path to classify.
optsVfsOpts?`{ root = "/source/" }`.

examples

if vfs.isDirectory("/zero/source/Goblin.dynamicAsset") then print("folder asset") end

stat(path: string, opts: VfsOpts?) →

What is at `path`, how big it is and when it last changed, without reading it. `size` is how many bytes `vfs.read(path)` returns: the length the layer holding the file states (a file held in memory, a synced or staged file), so a large file costs nothing to measure, and where no layer states one (a runtime node, a built-in library file) the length of the bytes this engine holds. It is absent for a directory and for a file whose length nothing states and whose bytes are not on this engine. `modified` is when this engine's copy last changed, in seconds since the Unix epoch (the scale `os.time()` reads): the write or arrival that put the current content there, which a move carries along with the content. The memory layer records it for every file whose bytes it holds: text up to the inline size threshold, and everything on an engine with no world bound. It is absent where no time is recorded: a directory nothing was written into as such, a runtime node, and a file whose bytes the blob store holds (binary content, and text past the inline size threshold, on a world-bound engine). For a file, the shell's `stat` and `ls -l` print the same size and time. A path nothing is at answers nil and the reason, the sentence a `vfs.read` of it gives. To tell whether a file changed without reading it: `vfs.contentAddress(path)` names the bytes the blob store holds, and `vfs.contentVersion(path)` moves on every change this session to a file the memory layer holds.

argtypedescription
pathstringVFS path.
optsVfsOpts?`{ root = "/source/" }`.

examples

local s = vfs.stat("/zero/source/scenes/main.scene/scene.json"); if s then print(s.size, s.modified) end

isSaveExcluded(path: string, opts: VfsOpts?) → boolean

Does this path hold content the machine keeps to itself? `/source/tmp/` is session scratch and `/source/local/` is this machine's own durable content — each directory itself included, and everything under it. Both are writable, hot-reloadable and enumerable like the rest of `/source/`; what separates them is where they stop. The engine filters them out of every world save and every peer broadcast, so they reach no world, carry no manifest row there, and a staging verb handed one refuses it by name. The match reads a whole path segment, so `/source/tmpfoo/` is ordinary content. Ask here whenever your code has to agree with what a world can hold.

argtypedescription
pathstringVFS path to classify.
optsVfsOpts?`{ root = "/source/" }`.

examples

if not vfs.isSaveExcluded(p) then table.insert(publishable, p) end

installedFrom(path: string, opts: VfsOpts?) → InstalledFrom

Where the asset holding `path` comes from, when the library carries it by reference. The library's source then holds an install record naming the asset, the world that published it and the commit its bytes are, and the engine serves the asset's files from those. `path` is the asset's own folder or anything inside it. Nil for a path whose bytes the library or the world holds itself.

argtypedescription
pathstringVFS path of the asset or of anything inside it.
optsVfsOpts?`{ root = "/source/" }`.

examples

local from = vfs.installedFrom(ref.path) if from then print(from.world, from.commit) end

movedReferenceNames(path: string?, opts: VfsOpts?) →

The world sources that spell a reference by a name its target no longer has. A source records, beside each name it uses, the guid of the asset the name reached; when that asset later sits at another path (it was moved, or the engine's library files it elsewhere), the reference keeps resolving through the guid while the text keeps the old name. This lists those sources and changes nothing. Writing an entry's `currentText` back with `vfs.write(source, currentText)` brings the text up to date without changing what any reference resolves to. Only sources the world authors are considered: the engine library and `/source/deps/` keep the text they were published with. when none does.

argtypedescription
pathstring?One source to ask about; every source the world authors when absent.
optsVfsOpts?`{ root = "/source/" }`.

examples

for _, s in ipairs(vfs.movedReferenceNames()) do print(s.source, #s.names) end

exists(path: string, opts: VfsOpts?) → boolean

Is the path known to the VFS? Checks the Stage-1 metadata (`.meta` sidecar / ManifestView) — NOT "are the bytes locally cached?". Use `vfs.read(path) ~= nil` to confirm bytes are reachable.

argtypedescription
pathstringVFS path to check.
optsVfsOpts?`{ root = "/source/" }`.

examples

assert(vfs.exists("@builtin/models/Cube"))

contentAddress(path: string, opts: VfsOpts?) → string

The content address (sha-256 hex) of the bytes `vfs.read(path)` returns, for a path whose bytes the blob store holds, answered synchronously and without the bytes. Two answers that agree name the same bytes, and a write that changes them changes it. Nil for a path whose bytes are held in memory (text under the inline size threshold, a play shadow, a kept read), which a synchronous `vfs.read` already returns, and for a path nothing is stored at. Keep it beside a copy of a file you read to tell, from a caller that cannot yield, whether the copy is still what the path holds.

argtypedescription
pathstringVFS path.
optsVfsOpts?`{ root = "/source/" }`.

examples

local address = vfs.contentAddress("/zero/source/scenes/main.scene/scene.json")

readAsync(path: string, opts: VfsOpts?) → string

Asynchronous binary-safe read. Returns a promise ID that resolves to the file contents. Useful for reading render textures from the main thread without blocking.

argtypedescription
pathstringVFS path.
optsVfsOpts?`{ root = "/source/" }`.

examples

local data = task.await(vfs.readAsync("/zero/runtime/screenshots/last.png"))

reload(modulePath: string?) → boolean

Clear entries from the `require()` cache so the next `require(name)` re-runs the module's source. Pass a single module identity to drop only that entry; call with no arguments to drop every cached module of the world's own. A module of the built-in library runs once for the process — its body registers into registries that outlive it — and stands through a reload with no argument. The next `require` runs the source the module's file holds when the reload is called, whichever write brought those bytes there, a `quiet` one included. module of the world's own). that name and has now been dropped — `false` says the name matched nothing. The no-arg form returns true.

argtypedescription
modulePathstring?Module identity to reload (omit to reload every

examples

vfs.reload("@mylib/utils.helpers")

evict(path: string, opts: VfsOpts?) → boolean

Drop the in-memory bytes for `path` from the writable MemFs layer without removing the asset. Use after processing large binaries to reclaim RAM.

argtypedescription
pathstringVFS path whose bytes should be evicted.
optsVfsOpts?`{ root = "/source/" }`.

examples

vfs.evict("/zero/source/textures/imported_big.png")

memResident( ) →

List the MemFs entries that are NOT resident-by-default — the writable in-memory layer's binary blobs and its large text files (text at or above the inline-text size threshold). These are the bytes `vfs.evict` can reclaim: the ones kept in RAM rather than left to fall through to the on-disk BlobStore cache. Small text (resident by default) is omitted. The audit counterpart to `vfs.evict` and to reading with `{ keep = true }` — use it to see what encoded bytes are held in RAM, and why. content and `"large-text"` for oversized text. Empty when the VFS isn't up.

examples

for _, e in ipairs(vfs.memResident()) do print(e.path, e.bytes, e.kind) end

durability(paths: string | { string }, opts: VfsOpts?) → Durability

Did that write save to disk, and if not how is it kept? What became of the bytes just written at `paths` — one path, or an array of them answered as ONE write. `durable` is true when they are where the call filed them and the next session reads them back, and false when the play shadow took any of them (live in this session and undone by a guarded play-exit unless kept) or any of them is in `/source/tmp/` scratch (this session's working space: it reads back while the engine runs and is gone when it stops or restarts, in edit mode and in play alike). `/source/local/` is durable: the machine keeps it. `durable` is present whatever the answer is, so its absence is never a reading. A non-durable answer carries `survivesRestart` (false whenever a restart of this engine ends the bytes, as it does for the play shadow and for scratch) and `warning` (the state and what a restart does with it, for a reader scanning values rather than checking a field; it opens with `PLAY SESSION`, `PLAY SHADOW` or `SCRATCH`). When the shadow holds a path the answer also carries `playShadow` (the routes to disk and what each costs a session other people are running in) and `shadowed` (which of the given paths the shadow has, or under `pending` would take); when a path is in scratch it carries `scratch` (which of them are in scratch). This is the answer, off the same shadow set and in the same words, that the `write_file` / `edit_file` / `capture` tools attach to their own results and that `asset.create` reports as its second return value. Ask it here at any other site that lands files, so every write surface states where the bytes went in one set of terms. write. A path resolves the way `vfs.write` resolves its own — absolute or `@`-rooted as it stands, a bare one under `/source/` — so the answer is about the file that write landed. A value that is not a path — an AssetRef, a record, a number, a string with nothing in it — raises rather than being answered off the empty set it reads as; a list with no entries names nothing and answers durable. the same question of a write that has NOT landed yet: where bytes written at these paths would go, read off the same play-lock verdict that will decide it. That is what a surface arranging a write it files later reports from — `av.record` opens a take here and the film is written when the take ends — because until those bytes land the shadow is holding nothing under the path and the answer would be durable at the one moment the caller can still act on it. The fields and the words are the same either way; the state names the tense it is true in. `survivesRestart` and `warning` present exactly when `durable` is false, `playShadow` and `shadowed` when the play shadow holds a path, `scratch` when a path is in `/source/tmp/`, which reads back while the engine runs and is gone when it stops or restarts.

argtypedescription
pathsstring | { string }One VFS path, or an array of paths answered together as one
optsVfsOpts?`{ root = "/source/", pending = false }`. `pending = true` asks

examples

local ok = vfs.write(path, body)
local d = vfs.durability(path)
if not d.durable then log.warn(d.warning) end
local ahead = vfs.durability("/zero/source/clips/take.mp4", { pending = true })

playShadowPaths( ) →

Every source write made during play that is not durable yet — the set to keep or discard before leaving play. Lists the `/source` paths edited during running play that the play shadow holds, each beside the pre-play copy a guarded discard puts back: the universal play shadow-copy set. These are the in-play edits persist promotes over the originals on confirm, or drops on a guarded discard. Empty outside play or when nothing was edited.

examples

for _, p in ipairs(vfs.playShadowPaths()) do print(p) end

playShadowAuthors( ) →

The caller behind each currently-shadowed `/source` path, in the shape `vfs.currentAuthor()` answers in: the id the write was attributed to, the name the world's roster holds for that caller now (`agent`, the one to show), its account's username, and the ZeroMind account it authenticated as. Several agents drive one engine at once and every one of their in-play source edits sits in the same shadow set, so this is how a review, a refusal or a verdict tells one agent's pending work from another's. `id` names the calling session where the call carried one, so two agent sessions on a machine linked to one ZeroMind account are two authors. A path written by a caller the engine could not name carries no entry, because it belongs to nobody in particular, and stays settleable by anyone.

examples

local mine = vfs.currentAuthor()
for path, who in pairs(vfs.playShadowAuthors()) do
if mine == nil or who.stable ~= mine.stable then print(path, "belongs to", who.agent or who.name) end
end

playShadowReceived( ) →

The `/source` paths other clients of the play room sent this client, each with the client it came from and, when the sender could be named, its author in the shape `vfs.playShadowAuthors()` answers in. These edits run here and the client that made them settles them, so they are in neither `vfs.playShadowPaths()` nor `vfs.playShadowAuthors()`; leaving play puts the pre-play copy back unless the sender promoted them.

examples

for path, from in pairs(vfs.playShadowReceived()) do print(path, "came from", from.client) end

currentAuthor( ) →

The caller this call is attributed to: the author a `/source` write made right now would be recorded under in the play shadow. `id` names the calling session where the transport attested one, so two agent sessions driving one engine read as two callers even when one linked ZeroMind account minted both their tokens. `stable` is the key the caller had before the world's roster named it, which a rename leaves where it was; one of several agents sharing a connection, which names itself with the `as` argument every tool takes, has a `stable` of its own. `connection` is the key of the connection the caller called over, the one the caller's staging area and the writer its dirty rows record are kept under, so the agents of one connection stage and commit one another's work. `agent` is the name the world's roster holds for the caller now; `name` is its account's username, which every agent of the account shares; `account` is that shared account. Nil when the engine can name no caller at all, which is the case for engine-authored work and for a caller that presented neither a session nor a token. Compare its `id` against `vfs.playShadowAuthors()` to separate your own pending edits from a co-author's.

examples

local me = vfs.currentAuthor()
print(if me ~= nil then me.id else "unattributed")

pendingWrites( ) →

List the `/source` paths with a local write or removal the synced manifest has not reflected yet: everything this client still owes the server. A just-written or just-removed file appears here until its upload round-trips and the synced dirty state catches up; `world.vcsStatus` unions these so a fresh edit reads back as dirty immediately, and `world.syncStatus().owed_paths` reports the same list. Empty when fully synced.

examples

for _, p in ipairs(vfs.pendingWrites()) do print(p) end

pendingWriteAuthors( ) →

The caller behind each `/source` path `vfs.pendingWrites` lists: the caller whose call made the newest local write or removal there, in the shape `vfs.currentAuthor` answers. A path changed by work no caller was attested for has no entry. `world.vcsStatus` reads it to name the writer of each row it lists before the synced manifest records one.

examples

for path, by in pairs(vfs.pendingWriteAuthors()) do print(path, by.connection) end

contentVersion(path: string) → number

A number that moves every time the file at `path` changes this session: each write, and each move onto it, stamps it with a version no file has held this session, and while nothing is stored at `path` (before it is written, after it is removed or moved away) it reads 0. It moves the moment any change lands, from every origin: a script's write, a peer's, a dev-mode disk pickup, a world-load or branch-swap write made before the world's content is ready, a world's unmount, both ends of a move, and a directory removal. Keep the value you saw when you last read the file, and read it again only when the number moved.

argtypedescription
pathstringThe file's path, in any form `vfs.read` takes.

examples

local seen = vfs.contentVersion("/zero/source/.world_settings")

mutationSeq( ) → number

Lifetime count of VFS mutations the engine has APPLIED — the drain's clock. A write queues its side effects (an asset's content reload, the assetType's `onChange`, a component or scene registration) and a later frame runs them; this number advances as each one completes. Read it, write, then poll for a larger value to learn the queue has moved past the point you wrote at — instead of waiting a guessed number of frames. It counts every mutation kind, so it answers about the pipeline rather than about one file; `asset.reloadSeq(ref)` is the per-asset reading.

examples

local at = vfs.mutationSeq()
vfs.write("/zero/source/tmp/note.txt", "hi")
repeat task.wait() until vfs.mutationSeq() > at

folderHashWalks( ) → number

Lifetime count of category-folder checksum walks — the part of a write's cost that grows with how much content already exists. A folder's checksum is the tree hash over the descendants that describe the asset, so deriving one reads every key under it, and a write re-derives it for each enclosing category folder whose bytes that write reaches. Content the checksum is made of therefore moves this once per enclosing folder per write; bytes that reach no checksum — a managed sidecar, a scene's autosave overlay — move it by nothing. Read it around a burst to learn what that burst cost in walks, a number that reads the same on a loaded machine and a quiet one.

examples

local at = vfs.folderHashWalks()
vfs.write("/zero/source/scenes/probe.scene/scene_dirty/entities/e1.json", "{}")
print(vfs.folderHashWalks() - at)

claimWalks( ) → number

Lifetime count of walks over every asset the world offers: the part of an enumeration's cost that grows with how many assets exist. `asset.list` reads a snapshot of every registered claim, built once for each change to what the world offers and shared by every list after it; `asset.categories` reads the category registry and walks nothing. Read it around a burst to learn what that burst cost in walks, a number that reads the same on a loaded machine and a quiet one.

examples

local at = vfs.claimWalks()
vfs.write("/zero/source/probe.module/init.luau", "return {}")
asset.list("module")
print(vfs.claimWalks() - at)

unmarkPlayShadow(path: string) → boolean

Forget a single play-shadow path after it has been promoted (saved over source) or discarded. Tracking only — never touches the bytes.

argtypedescription
pathstringVFS path to unmark.

examples

vfs.unmarkPlayShadow("/zero/source/Foo.component/init.luau")

clearPlayShadow( ) → boolean

Forget the entire play-shadow set after a bulk promote or discard. Tracking only — never touches the bytes.

examples

vfs.clearPlayShadow()

discardPlayShadow( ) →

Throw away every play-shadow edit: the discard a play-exit takes when the play session's work is not kept. Each path reverts to its pre-play copy, as vfs.revertPlayShadow does. Every path it throws away is returned in `discarded`, posted as a notice and logged by name. A path whose pre-play copy cannot be put back yet (the world's blob, still being pulled; the world's manifest row, read once the manifest has taken the update it is applying; or a copy whose write back is refused) leaves the play shadow all the same and is OWED: it holds the play bytes until the copy lands and its write is taken, and the copy is put back then, unless the path has changed in the meantime. Every owed path is returned in `owed`, posted as a notice and logged by name. Calling it again asks for every owed restore again, pulling a copy whose pull failed. sorted, owed ones included. `owed`: every path it left owed, sorted by path, with why its restore has not landed; empty when every path reverted.

examples

local result = vfs.discardPlayShadow()
for _, path in ipairs(result.discarded) do
print("discarded", path)
end
for _, owed in ipairs(result.owed) do
print(owed.path, owed.reason)
end

playDiscardsOwed( ) →

The play edits a discard threw away whose pre-play copy has not been put back yet. Each of these paths holds the play session's bytes until its restore lands, which happens on its own once the copy arrives and its write is taken. A path that changes first keeps its new content and leaves this list. landed.

examples

for _, owed in ipairs(vfs.playDiscardsOwed()) do
print(owed.path, owed.reason)
end

playHoldsInPlace(path: string, opts: VfsOpts?) → boolean

Whether the running play session holds `path` where it stands: `vfs.move` of it, and `vfs.remove` of it without `durable = true`, are refused while play runs, because what they would take away is content that predates play (or that a durable write made canonical). Content only the play shadow holds (this play session wrote it) answers false and moves freely, and so does every path once play ends or pauses, a path in `/source/tmp/` or `/source/local/`, and a path outside authored source. Ask it before the first step of a change that ends by taking `path` away, so a change the lock would refuse at its last step is not started: the importers ask it before relocating a source into the asset they produce, and owe the import until play ends.

argtypedescription
pathstringThe VFS path: absolute, `@`-rooted, or bare under `/source/`.
optsVfsOpts?`{ root = "/source/" }`.

examples

if vfs.playHoldsInPlace(src) then log.warn(src .. " moves once play ends") end

sessionLost( ) → boolean

Whether the live world session this engine established is lost and reconnecting. While it is, every write this engine makes to authored source (`/source` outside `/source/tmp/`) is refused, because the backend of a dropped session can never receive it; the refusal names the reconnect. It answers false again from the frame the session re-establishes, and is false on an engine whose session never established (an offline boot, or a world still binding) unless `vfs.simulateSessionLoss` put it in that state. Ask it before, or after a failure of, work that writes source in steps: the importers do, and owe such an import until the session is back. session is lost.

examples

if vfs.sessionLost() then log.warn("writes wait for the live session") end

simulateSessionLoss(lost: boolean) → void

Put the VFS in the state a lost live session puts it in (`true`), or take it out of it (`false`), without touching the connection: `vfs.sessionLost()` answers it, and every write to authored source is refused exactly as it is while a real session is reconnecting. Once a live session has established, the engine's connection observer states the real session every frame, so the simulation holds on an engine whose live session never established (an offline boot), which is where a test drives the paths that answer a lost session. false to accept them again.

argtypedescription
lostbooleanTrue to refuse writes to authored source as a lost session does,

examples

vfs.simulateSessionLoss(true)
vfs.simulateSessionLoss(false)

simulateFailedFetch(path: string, opts: VfsOpts?) →

Test support. Put the file at `path` in the state a failed fetch of its bytes leaves it in: the world holds the path (`vfs.exists` answers true, and its identity and listing stand) and its bytes are not on this engine, so `vfs.read` of it answers nil and the reason `<path>: this world holds the path, and its bytes are not on this engine`. It is the state a world session lands a file in when the fetch of its bytes finds none upstream, reached for a file only this engine's memory holds (any file on an offline engine, and `/source/tmp/` scratch on a world-bound one), so a test drives the readers that meet such a file. A write of the path puts bytes there again. Relative paths are resolved under `opts.root` (default '/source/'). for a path whose bytes this engine does not hold in memory, for a path whose bytes another layer or the world's content store would still serve (a file this session synced to its world), and for a path nothing but its bytes states, each left as it was.

argtypedescription
pathstringThe file whose bytes this engine stops holding.
optsVfsOpts?Options: `{ root = '/source/' }`.

examples

local ok, why = vfs.simulateFailedFetch("/source/tmp/probe.scene/scene.json")

holdContentSync(held: boolean) → void

Hold (`true`) or release (`false`) the content sync of the world this engine binds. While it is held, a take of the world's content (the initial sync a binding runs, or the one a session that lost its connection runs when it subscribes again) applies no row: the rows the backend sends wait unapplied, in order, and are applied the moment the hold is released. The binding stands and writes to authored source are taken and uploaded meanwhile, so the engine sits between binding a world and being shown its content for as long as a test needs it there: `world.syncStatus()` reads `content_synced = false` and `content_sync_held = true`, and the world's load waits at its content step. A take that already finished carries on applying live changes; the hold stops the next take at its first row. A boot started with `--hold-content-sync` (`holdContentSync=1` in a browser launch) raises the hold before the world binds, which is how the initial sync of a fresh engine is held.

argtypedescription
heldbooleanTrue to hold the content sync, false to release it.

examples

vfs.holdContentSync(true)
vfs.holdContentSync(false)

promotePlayShadow(path: string | { string }) →

KEEP a source write made while play was running — the call that saves a play-mode edit onto disk and makes it durable. Promotes play-shadow edits into canonical writes: re-asserts the live overlay bytes through the full write pipeline, then unmarks each path. The bytes stay in the engine end to end, so binary content promotes exactly. It answers while play is RUNNING and leaves the mode, the clock and every shadow entry it did not name exactly where they stood. Takes ONE path, or an ARRAY of them — a single folder-asset write shadows the entry file, the README and the metadata together, so a slice is tens of paths, and naming them keeps the call to the caller's own work on an engine other sessions are running in. Every named path is attempted; one that refuses does not stop the ones after it. A path with nothing on the play shadow at it or beneath it settles nothing and raises nothing, since no play edit stands there: the third return value names it. A promotion that cannot happen raises with the reason: the path is a plain folder covering shadowed edits (the refusal names the first five assets and loose files under it by the paths that settle them, and counts the rest), the workspace is read-only, or the write-through failed. A shadow entry whose bytes are gone is dropped as promoted, so the path comes back with nothing written for it. A folder asset is kept whole: a file of one promotes with every other shadowed file of the same asset, so the files its type requires reach source with whichever of them was named, and naming the folder asset's own path (`Gold.material`, `controls.inputMap`) promotes every shadowed file of it, the assets nested in it included. An asset nested inside another settles with its own files, and takes the own files of every enclosing asset the play session made with it, since it stands on source only inside them. A path an earlier call settled, by name or carried this way, answers as settled when it is named again, so a walk over a `vfs.playShadowPaths()` snapshot one path at a time settles every path in it. vfs.playShadowPaths()). there), or the array of settled paths when an array went in; then the array of every path the call settled, a folder asset's carried files included; then the array of named paths that held nothing on the play shadow. None of the named paths are shadowed any more.

argtypedescription
pathstring | { string }A shadowed VFS path to promote, or an array of them (from

examples

local promoted = vfs.promotePlayShadow("/zero/source/cover.jpg")
local _, settled = vfs.promotePlayShadow("/zero/source/Hero.module/init.luau")
local _, kept = vfs.promotePlayShadow("/zero/source/game/Gold.material")
local named, _, unshadowed = vfs.promotePlayShadow("/zero/source/maybe_written.md")
local mine = {}
for _, p in ipairs(vfs.playShadowPaths()) do
if string.find(p, "/zero/source/mine/", 1, true) == 1 then table.insert(mine, p) end
end
local settled = vfs.promotePlayShadow(mine)

revertPlayShadow(path: string | { string }) →

DISCARD a source write made while play was running, keeping nothing — the opposite of promoting it. Reverts play-shadow edits: restores the pre-play copy captured at the first play-mode write (the last edit-mode state, unstaged edits included) into the live slot — or remove the file when it did not exist at that moment — then unmark the path. Hot-reload picks the original back up, so the running session actually reverts. It answers while play is RUNNING and takes ONE path or an ARRAY of them, on the same terms as vfs.promotePlayShadow. A revert that cannot happen raises with the reason. A file of a folder asset reverts with every other shadowed file of the same asset, as a promotion carries them, and a file of an asset the play session made reverts with every shadowed file beneath it, the assets nested in it included. Naming the folder asset's own path reverts every shadowed file of it. A path with nothing on the play shadow settles nothing and raises nothing, as for vfs.promotePlayShadow. A path an earlier revert settled answers as settled when it is named again; one an earlier promotion settled raises, naming that promotion. vfs.playShadowPaths()). shadow there), or the array of reverted paths when an array went in; then the array of every path the call reverted, a folder asset's carried files included; then the array of named paths that held nothing on the play shadow. None of the named paths are shadowed any more.

argtypedescription
pathstring | { string }A shadowed VFS path to revert, or an array of them (from

examples

local reverted = vfs.revertPlayShadow("/zero/source/Foo.component/init.luau")
local dropped = vfs.revertPlayShadow({ "/zero/source/a.md", "/zero/source/b.md" })

watch(path: string, callback: (string, string, string) →

Register a callback that fires when a VFS path is written or removed. Two match modes: exact, or folder/prefix (key ends with `/`, and fires for any descendant). The callback runs in the VM that registered it. Returns a watcher id for `vfs.unwatch`. `"remove"`; origin `"local"` for a change this engine made (through `vfs.*`, the shell or any other surface) and `"remote"` for one that arrived from another participant in the world.

argtypedescription
pathstringExact path, or folder path ending in `/`.
callback(string, string, string`(mutated_path, kind, origin) -> ()`, kind `"write"` or

examples

local id = vfs.watch("/zero/source/", function(path, kind, origin) print(kind, origin, path) end)

unwatch(watcherId: number) → boolean

Remove a previously registered VFS watcher.

argtypedescription
watcherIdnumberWatcher id returned by `vfs.watch`.

examples

vfs.unwatch(id)

open(path: string, opts: VfsOpts?) → PluginHandle

A reader of the file at `path`, to pass a plugin in a call. The plugin reads it by range and reaches nothing else through it; it is refused, raising the reason, where this script could not read. A reader whose file leaves its path answers the plugin that the asset is gone.

argtypedescription
pathstringThe file to read.
optsVfsOpts?`{ root = "/source/" }`.

examples

local weights = vfs.open(asset.containing(__FILE__).path .. "/weights.gguf")

openDir(path: string, opts: VfsOpts?) → PluginHandle

A reader of the folder at `path` and everything under it, to pass a plugin in a call. The plugin lists it and opens readers of its files, by paths relative to the folder that cannot leave it.

argtypedescription
pathstringThe folder to read.
optsVfsOpts?`{ root = "/source/" }`.

examples

local model = vfs.openDir(asset.containing(__FILE__).path .. "/model")

sink(path: string, opts: SinkOpts) → PluginHandle

A sink for the file at `path`, to pass a plugin in a call. The plugin writes it from empty, up to `opts.maxBytes`, and the file lands when the plugin closes the sink or drops it. Only the world's own files take a sink.

argtypedescription
pathstringThe file to write.
optsSinkOpts`{ maxBytes = <bytes> }`, required.

examples

local out = vfs.sink("/source/imported/sphere.zvol", { maxBytes = 64 * 1024 * 1024 })

dirSink(path: string, opts: DirSinkOpts) → PluginHandle

A sink for new files under the folder at `path`, subfolders included, to pass a plugin in a call. The plugin makes whatever files it Only the world's own files take a sink.

argtypedescription
pathstringThe folder to write under.
optsDirSinkOpts`{ maxFiles = <n>, maxBytes = <bytes>, extensions = { "png" }? }`.

examples

local frames = vfs.dirSink("/source/frames", { maxFiles = 240, maxBytes = 200 * 1024 * 1024, extensions = { "png" } })
⌬ Types
PluginHandle = anySinkOpts = { maxBytes: number, root: string? }DirSinkOpts = { maxFiles: number, maxBytes: number, extensions: { string }?, root: string? }VfsOpts = {VfsListEntry = { name: string, isDirectory: boolean, path: string }VfsStat = {Durability = {WriteDiagnostic = {WriteContentRequirement = {WriteReport = {InstalledFrom = {MovedReferenceName = {MovedReferenceSource = {

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.

38+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_version Per-path content-version counters — a cheap, synchronous "has this file changed?" token. An assetType behavior memoizes its parse in the ref's `runtime` keyed by the counter `get(path)` returned when it parsed, then serves every later read as an integer compare instead of re-reading and re-parsing the file. ## Why it exists A `.data()` behavior that re-reads and re-parses its source on every call is pure overhead when the file hasn't changed. This module gives it a version token to gate the rebuild on: - `get(path)` when the parse ran, stored alongside the parsed value. - On every later call, compare `get(path)` to the stored value — equal means the cache is still valid (no `vfs.read`, no parse); a bump means rebuild. ## Exports - `M.get(path: string) -> number` — the path's current version counter (`0` if never written this VM). - `M.bump(path: string)` — bump `path`'s counter, invalidating every reader memoized against its previous value. Content code rarely calls this directly. ## What bumps a counter Two write surfaces feed it, so the token reflects a change no matter where it originated: - `vfs.write` / `vfs.move` / `vfs.remove` bump **synchronously**, in the same call — so a script that writes a file and reads it back in the same tick sees the new content immediately (the asset-change `onChange` dispatch fires a frame later, too late for a same-tick read). - the generic asset-change dispatcher bumps on every source write it routes, including peer-synced and engine-originated writes that never pass through the Luau `vfs.*` surface — with the engine's normalized path, the canonical form a reader keys on. ## Per-path, not a global epoch Counters are per **path**, not one global epoch. The per-frame dirty-entity writer churns scene-dirty paths every frame during play; a global epoch would let that churn invalidate every unrelated cache. Per-path isolation means only a change to the file a reader depends on rebuilds it. The counters are held once for the process (`__contentVersion`), so a single store is shared across every VM and every copy of this module that a require-cache reset (`vfs.reload`) might create. A bumper and a reader that landed on different VMs or module copies read the same number: a write made in a worker VM, the engine thread's dispatch of it, and a write made on the engine thread advance one counter.
▲ 0↑ born
▣
module · born here
❒asset
# vfs_async_read Pure-Luau wrapper that grafts a yielding `vfs.read` over the engine's sync `vfs.read` binding. The `vfs` API module (`modules/api/engine/vfs`) calls `M.installInto(vfs)` on itself as it loads, so every VM holding `vfs` (user VMs and the trusted VM alike) reads through it; user code never requires this module directly: it just calls `vfs.read(path)` and the wrapper handles cache misses by yielding the running coroutine until the bytes resolve. ## Exports - `M.installInto(vfs: VfsNamespace)`: replace `vfs.read` (and `vfs.readBounded` and `vfs.list`) with the yielding wrapper. No-op when the target lacks `read` and `readAsync` as functions. - `M.CANNOT_WAIT`: `"VFS_READ_CANNOT_WAIT"`, the code a read raises when it names a known file whose bytes have not arrived and the reading code cannot yield. Types: - `VfsNamespace = { read?, readAsync?, readBounded?, list? }`: the engine's `vfs` global shape. ## Usage ```luau -- The `vfs` API module installs the wrapper onto itself as it loads: require("@builtin::modules.vfs_async_read").installInto(vfs) -- After install, every `vfs.read` call yields on cache miss, and a read -- that finds no bytes answers nil and the reason: local bytes, why = vfs.read("/zero/source/some.asset") ``` ## Where a read can wait - On a miss the wrapper schedules `vfs.readAsync(path, opts)`, which fires `BlobProvider::fetch` under the hood, and `task.await`s the promise. A wait that resolves without bytes answers nil and the reason: the sentence the engine's read gave beside its nil, or, for bytes that were on their way, the one it gives once the wait ends. - Waiting takes a yield, so it happens where `coroutine.isyieldable()` is true: a task, the component hooks the engine runs on a coroutine (`awake`, `start`, `update`, `fixedUpdate`, `onEnable`, `onOwnerChanged`, `onSyncReceived`), a replicated event's handlers, and a world or scene entrypoint's hooks. - Where it is false (`onDisable`, `onDestroy`, `onPropertyChanged`, a received synced-function call, a `vfs.watch` callback, a module's top level while `require` runs it, a metamethod, a `table.sort` comparator, a VM's main thread) a miss the engine's read answers `nil, "pending"` for (a file `vfs.exists` knows that is no directory and whose bytes can still arrive, a render surface being captured, a `/runtime/sync` node whose current reading the next frame assembles) raises `VFS_READ_CANNOT_WAIT: vfs.read("<path>") ...`, naming the path and the places it can be read from. Every other miss answers nil and the reason there as everywhere else. - `vfs.list` answers a directory whose current listing the next frame assembles (a `/runtime/sync` directory nothing has read lately) after waiting that frame where the code can yield, and raises `VFS_READ_CANNOT_WAIT: vfs.list("<path>") ...` where it cannot. - `installInto` is idempotent in the trivial sense: calling it twice re-wraps `vfs.read` around the already-wrapped function, which is fine but pointless.
▲ 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
# 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
▣
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/api/engine/vfs.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.