Start here
Words
The words Patchwork uses, each in one line.
Scenes
- scene
- A file saying how a world starts and which plugins it uses. A game's manager scene holds its other scenes.
- world
- A scene's fixed numbers and settings. Seats are never sent it.
- prefab
- The starting values of a new row's changing fields, one per kind.
- actors
- The rows a scene starts with, one entry each.
Things in the world
- row
- One thing in the world, holding what every seat must agree on.
- kind
- What a row is.
- definition
- A kind's fixed numbers, its entry in the game's data file.
- actor
- A kind's code: its rule, run on the server every step, and its drawing, run in the page.
- hook
- A rule that runs every step:
before,tickorafter. - act
- Something a row can be asked to do.
- open
- The acts any seat may ask for, not only the seat that possesses the row.
- spawn
- To make a row.
- end
- To take a row out of the world.
- seed
world.seed, the number every random roll in a truth starts from, so the rolls are the same every run.- die
w.die(), a random roll from 0 up to 1 drawn from the seed.
Running
- truth
- A running world, held by the server.
- step
- One tick of a truth's time. Every hook runs once and every seat is sent a packet.
Seats and the wire
- seat
- A player's place in a truth.
- slot
- The number of a seat: 0, 1, 2 and on.
- possess
- To play as a row. A seat possesses its own
playerrow. - message
- A seat asking a row to act, sent from the page to the truth.
- packet
- What a seat is sent each step: the rows it may see.
- piece
- What decides what each seat may see and send, such as interest or vision.
- client
- The page's side of a seat.
- pipe
- What a client takes packets from and sends messages down, connected by scenemanager.
- wire
- A transport's page side.
- transport
- The addon that carries packets and messages: loopback in one process, socket between two.
- envelope
- A packet or message labelled with the scene it belongs to.
Homes
- plugin
- A piece that lives in the world or in the player's browser, with a server half, a browser half or both.
- addon
- A piece that holds a truth: seats, connections, files, timers, or what a packet carries.
- mod
- A file by which one plugin gives another what it knows, switched on by the scene.
- ledger
- A row that only appends events, each played or drawn once by the page.
- store
- The page's own values, such as volume or rebound keys, which the server never sees.
- catalogue
- A scene's list of the files the game uses.
- local
- State only this page needs, such as the camera or a menu cursor. It is never sent to the server.
- page
- One of a game's HTML files:
index.html,client.htmlordev.html. - testbed
dev.html, the page where any scene can be entered and any value overridden.
The editor
- extension
- A piece of the editor, as a plugin is a piece of a game.
- recorder
- What holds a game's truths under the editor's clock and rebuilds any step by replaying.