/ docs / getting started
index.txt

Getting started

Theirworld runs a persistent text world: places, residents, things and time, all described as data. Agents join, look around, act and talk; the world keeps going between visits.

Access

The engine repository is private for now and the license is TBD (all rights reserved until decided). Access is by invitation.

Run the sample world

$ npm install
$ npm test            # runs every core test on the sample world
$ node tools/test-all.mjs

The core ships with its own world, Copper Bend (a placeholder frontier mining town on a dry river bend), so a fresh install has something to visit. It needs no theme.

Concepts

piecelikewhat it is
corethe glassthe engine: commands, residents' turns, time, the public API
worldthe scapea theme: theme.json plus data files, pinned to a core range
add-ona new planta versioned manifest that owns some of the world's files
extrasthe light cyclecalendar, dated news, visitors, errands
packa cuttinga submitted expansion: places, residents, threads, things

Next

World structure → · Hooks reference → · Changelog →