goldbuick/zed-software-system

A zzt-inspired web based software framework

3

stars

5,028

commits

TypeScript

primary language

Sep 12, 2026

updated

zed.cafe

README

zed software system

A ZZT-inspired, web-based fantasy terminal — a creative-coding and game environment. Deep stack overview: zss/ARCHITECTURE.md.

Documentation

SurfaceURL / pathAudience
System reference (this repo)https://zed.cafe/docs/Developers and creators — architecture, glossary, colocated zss/**/docs
In-game / ZNS helphttps://docs.at.zed.cafePlayers and authors via ROM refscrolls

Blume project root: docs-site/. Module manuals stay colocated under zss/**/docs/ (see .cursor/rules/docs-placement.mdc). Local preview: yarn task blume dev. Production merge is part of yarn task run cafe:buildcafe/dist/docs/.

Development

From the repo root (requires Yarn and a current Node.js LTS):

All workflows run through the task CLI. Full index: ops/docs/tasks.md.

CommandWhat it does
yarn task run cafe:devInstall deps, then start the Vite dev server at https://localhost:7777 (binds 0.0.0.0).
yarn task run ops:testRun the Jest suite (120s per-test timeout).
yarn task run ops:lintImport guards, then parallel depcruise, ESLint, and tsc --noEmit. Pass --fix (also yarn task ops lint --fix) for eslint autofix only.
yarn task run ops:native:lintclang-format check on first-party C++ (requires LLVM clang-format 18+).
yarn task run ops:docs:check-linksCheck relative links in tracked *.md files.
yarn task listList all tasks by group.

Shorthand: ./task cafe dev (or yarn task cafe dev) is equivalent to yarn task run cafe:dev.

Press Ctrl+I (or run #perf in the terminal) to toggle the in-game perf overlay; see zss/perf/README.md.

Production build: yarn task run cafe:build (Vite app + Blume docs at cafe/dist/docs/). Chip scripts compile via the TypeScript lang backend. Per-area docs live under zss/**/docs/ and selected ops/docs/ pages (mounted into the docs site).

Desktop helpers (Releases)

Electron installers for the media-queue helper attach to GitHub Releases on v* tags. Windows signing: free code signing provided by SignPath.io, certificate by SignPath Foundation (setup).

Contributors

goldbuick

4,992 commits

cursoragent

2 commits

goldbuick/zed-software-system

A zzt-inspired web based software framework

3

stars

5,028

commits

TypeScript

primary language

Sep 12, 2026

updated

zed.cafe

README

zed software system

A ZZT-inspired, web-based fantasy terminal — a creative-coding and game environment. Deep stack overview: zss/ARCHITECTURE.md.

Documentation

SurfaceURL / pathAudience
System reference (this repo)https://zed.cafe/docs/Developers and creators — architecture, glossary, colocated zss/**/docs
In-game / ZNS helphttps://docs.at.zed.cafePlayers and authors via ROM refscrolls

Blume project root: docs-site/. Module manuals stay colocated under zss/**/docs/ (see .cursor/rules/docs-placement.mdc). Local preview: yarn task blume dev. Production merge is part of yarn task run cafe:buildcafe/dist/docs/.

Development

From the repo root (requires Yarn and a current Node.js LTS):

All workflows run through the task CLI. Full index: ops/docs/tasks.md.

CommandWhat it does
yarn task run cafe:devInstall deps, then start the Vite dev server at https://localhost:7777 (binds 0.0.0.0).
yarn task run ops:testRun the Jest suite (120s per-test timeout).
yarn task run ops:lintImport guards, then parallel depcruise, ESLint, and tsc --noEmit. Pass --fix (also yarn task ops lint --fix) for eslint autofix only.
yarn task run ops:native:lintclang-format check on first-party C++ (requires LLVM clang-format 18+).
yarn task run ops:docs:check-linksCheck relative links in tracked *.md files.
yarn task listList all tasks by group.

Shorthand: ./task cafe dev (or yarn task cafe dev) is equivalent to yarn task run cafe:dev.

Press Ctrl+I (or run #perf in the terminal) to toggle the in-game perf overlay; see zss/perf/README.md.

Production build: yarn task run cafe:build (Vite app + Blume docs at cafe/dist/docs/). Chip scripts compile via the TypeScript lang backend. Per-area docs live under zss/**/docs/ and selected ops/docs/ pages (mounted into the docs site).

Desktop helpers (Releases)

Electron installers for the media-queue helper attach to GitHub Releases on v* tags. Windows signing: free code signing provided by SignPath.io, certificate by SignPath Foundation (setup).

Contributors

goldbuick

4,992 commits

cursoragent

2 commits

Languages

TypeScript

89.2%

JavaScript

5.7%

C++

2.5%

MDX

2.1%