@origingame/create-game 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# @origingame/create-game
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Scaffolds an Origin Engine game from the project template (`templates/game`
+of the engine repository): `project.ogt`, `src/`, `assets/`, `tests/`,
+`package.json` and `tsconfig.json`, with the game's name and id filled in.
+
+```sh
+bun packages/create/bin/create.ts my-game --name "My Game"   # in the engine repository
+cd my-game && bun install && og cook && og run .
+```
+
+`create [dir] [--name "Name"] [--id slug] [--archetype name] [--premise "one line"] [--look slug] [--force]`: the
+id defaults to the name in lowercase-hyphen form (or the directory's name);
+a directory that is not empty is refused unless `--force` is given.
+`--archetype` starts from a complete game of `templates/archetypes/`
+instead of the template: `runner`, `match3`, `topdown`, `tower-defense`,
+`roguelike`, `idle`, `rhythm` or `third-person` (the published package carries them under
+`archetypes/`).
+
+Every game gets its look: `assets/looks/<id>.ogt`, an `.ogt` of `type look`
+(og-taste §12 of the knowledge package) that `GameDesc.look` in the entry
+names, applied before `start` runs. It `extends` a preset of the style
+catalogue (`packages/knowledge/looks/catalogue.json`, 37 styles):
+
+- `--look <slug>` names it (`anime-cel-3d`, `16bit-pixel`, …; a slug with
+  no preset is refused, listing those that have one);
+- `--premise "<one line>"` picks the style whose premise fits best (a word
+  of the premise in a style's genre counts 3, in its mood 2, in its era,
+  audience, name or descriptor 1; a tie goes to a style the engine draws
+  whole, then to catalogue order). On a terminal, with neither flag, create
+  asks for the premise (`--no-prompt` does not);
+- otherwise the template's own look stays: the plain template extends
+  `faceted-low-poly`, the idle archetype carries its skin and render
+  settings, and the other archetypes get a look that extends nothing (their
+  frames stay as their `references/` recorded them).
+
+The template's look file is renamed to the game's id, the blocks it sets
+are kept under the chosen preset (they win field by field), and an entry
+that names no look gets `look: "looks/<id>.ogt"` after `export default
+og.game({`. The game's README gains a "The look" section: where the file
+is, what it extends and how to change it. For an archetype, a preset moves
+the frames its `references/` hold; create says so and how to record them
+again.
+
+The published package carries the template under `template/` and the style
+catalogue under `looks/`, copied by the `prepack` script
+(`scripts/pack-template.ts`); build output (`cooked/`,
+`dist/`, `node_modules/`) is never copied. The template's `gitattributes`
+(media through Git LFS) is written as the project's `.gitattributes`: under
+its own name it would route the engine repository's plain-blob media through
+LFS too. `bun run test` scaffolds into a
+temporary directory and checks the result.
+
+Note on the name: npm maps `npm create @origingame/game` to the package
+`@origingame/create-game` and `npm create @origingame` to `@origingame/create-game`.
+This package is `@origingame/create-game` (design §9); publishing it also as
+`@origingame/create-game`, or documenting `npm create @origingame`, is the
+publisher's choice.

package/archetypes/README.md

@@ -0,0 +1,99 @@
+# Archetypes
+
+Complete games a Maker starts from, each a project like `templates/game`
+(`project.ogt`, `src/`, `assets/`, `tests/`, `package.json`,
+`tsconfig.json`) that `og run`, `og test` and `og build` take as is. They
+rebuild the platform's six Godot Discover prototypes on Origin Engine,
+keeping each prototype's premise and lessons and none of its code or art,
+and add a top-down room built for the engine's 2D and game-feel modules
+and a third-person vale, the engine's mid-size 3D slice.
+
+| Directory | Game | Profile | Input | Core loop |
+|---|---|---|---|---|
+| `runner/` | Rooftop Run | 2d | one button: tap to hop, hold to jump | read the next crate or fence, time the jump, keep the pace |
+| `match3/` | Tile Swap | 2d | taps or drags | spot a line, swap, chase the cascade, beat the target in the moves |
+| `topdown/` | Tomb Room | 2d | WASD or arrows, Space to strike, Shift to dash | cross two rooms of a Tiled map, beat the slime, collect the coins and the key, open the door |
+| `tower-defense/` | Path Guard | 2d | taps, or the arrows and Space, or a pad | pick a plant, set it on the lawn, watch the visitors re-route round it, hold five waves |
+| `roguelike/` | Lamp Dive | 2d | the arrows or WASD, a tap on the next cell, a pad, or the HUD's d-pad | step a turn at a time through a fresh tomb, strike what the lamp shows, take what it finds, reach the relic on floor 2 with one life |
+| `idle/` | Spark Orb | 2d | taps or Space on the orb, 1–4 or the cards to buy, a pad | tap for sparks, buy generators that make them, double each kind every tenth, collapse into a supernova for stardust, come back to what it made while away |
+| `rhythm/` | Three-Lane Beat | 2d | A S D or the arrows, fingers on the lanes, a pad | read the notes falling to the line, hit each on its time, keep the combo and the groove, clear the song |
+| `third-person/` | Ember Vale | 3d | WASD or the arrows, Shift, Space, hold F, Q and E; a pad; a touch joystick, Jump and Kindle | walk, wade and jump a lake vale at dusk, kindle four beacons before night while stone sentinels on their rounds hunt you |
+
+Each archetype's README has its rules, components, systems, tunables, the
+commands its playtests use and what a Maker changes first.
+
+## What they share (and what each owns)
+
+- **Pixel-art sprites, flipbooks and tilemaps.** `tools/make-assets.py`
+  draws every sheet texel by texel (standard library only, through its
+  `tools/oglite.py`, the same file in every archetype) and writes its
+  `type flipbook` sheet (clips, modes, frame events), the tilesets and maps, and a `texture { kind pixel }`
+  import for each PNG; two runs give the same bytes. Drawn entities carry
+  `og.Sprite` (y-sorted, blob shadows) and play `og.Flipbook` clips; the
+  runner's skyline is three parallax `og.Tilemap` strips, the board's
+  checker a tilemap, the tomb a Tiled `.tmj` with 47-blob auto-tiled walls
+  and merged colliders. The same script makes the sounds and subsets a
+  font to the HUD's characters.
+- **Game feel from the engine.** `og.tween` (with the squash and flash
+  presets and completion events by tag), `og.time.hitStop`,
+  `og.camera.shake`/`kick`/`punch`, `og.render.floatingText` and
+  `og.Afterimage`; each README's Feel table names where each is used and
+  how much. The amounts follow the og-feel skill.
+- **One row shape.** Every drawn entity carries the same components, and
+  the round's state and tuning ride on every row with one row (the runner,
+  the board) as the authority: a system sees one query and cannot reach
+  another entity or a game resource yet. Each README says how this changes
+  once it can. The four later archetypes (tower-defense, roguelike, idle,
+  rhythm) keep the play in game resources (`Game`, `Tuning`, `Prefs`)
+  that every system reads and writes; a system still writes only the rows
+  its query declares, so what another system's rows must show is asked for
+  through a resource field and done by the owner the same tick.
+- **The platform and the screens.** The later four keep their settings
+  through `og.platform.loadSettings`/`saveSettings` and a record (a best,
+  a save) in the store at the revision read, merged after a stale write;
+  their title, pause, settings and end cards are og-ui widgets on a
+  recoloured style pack from `templates/ui-kit`, with every string in
+  `assets/strings/en.ogt` and `zh-CN.ogt`, and a phone layout inside the
+  safe area. Their `og polish` reports are in the engine repository's
+  `tests/evidence/P2/archetypes/`.
+- **The 3D one.** `third-person/` is the exception to the pixel-art
+  sprites: a heightmap terrain with water, the engine's CC0 humanoids on
+  og.CharacterController with blend trees and IK, navmesh sentinels on
+  og.ai, particles, decals and the post stack, on the fantasy style pack
+  (its README).
+- **The look as data.** `idle/` names its frame treatment and skin in
+  `assets/looks/idle.ogt` through `GameDesc.look` (og-taste §12); the
+  others set theirs in `start` until they move to a look. A look that
+  extends a catalogue preset changes the frames, so `references/` are
+  recorded again with it.
+- **Pools, not spawning in systems.** Obstacles, coins and tiles are spawned
+  in `start` and recycled by systems.
+- **Tunables.** The `Tuning` block (the scene's, or the component's
+  defaults in the topdown) holds them; `set:<entity>.Tuning.<field>=<value>` and Tune write
+  them live.
+- **Playtests through real input.** `tests/*.og.ts` drive keys, taps and
+  drags through the command channel, plus a game command or two (`place`,
+  `deal`, `swap`) for states a test needs at once, and assert on
+  `dump_entity` of the authority row. `tests/frames.og.ts` compares frames
+  with `references/<tier>/` (`OG_FX_CAPTURE=1 og test .` records them) and
+  `tests/replay.og.ts` runs the same input twice in fresh processes and
+  requires one world hash. `og test .` runs them.
+
+## Scaffolding one
+
+`@origingame/create-game` scaffolds `templates/game`, or an archetype with
+`--archetype <directory>`:
+
+```sh
+bun packages/create/bin/create.ts my-dive --archetype roguelike --name "My Dive"   # in the engine repository
+cd my-dive && bun install && og test . && og run .
+```
+
+It copies the directory (without `cooked/`, `dist/`, `og-out/` and
+`.og/`), sets `name` and `id` in `project.ogt` and `package.json`, and
+writes the archetype's `gitattributes` (media through Git LFS) as
+`.gitattributes`. It gives the game its look, `assets/looks/<id>.ogt`
+named by `GameDesc.look` (the archetype's own carried over, or one that
+sets nothing), and `--look <slug>` or `--premise "<line>"` makes it extend
+a catalogue preset: the archetype's reference frames then no longer match,
+and create says to record them again (`packages/create/README.md`).

package/archetypes/idle/.origin/setup

@@ -0,0 +1,14 @@
+#!/bin/sh
+# Prepares this Game's cloud sandbox snapshot: Origin runs it once per
+# snapshot build, in the checkout, without a terminal, for at most 20 minutes,
+# and saves the result for new sandboxes of the Game. Keep it idempotent; it
+# never receives credentials. Only ignored output is kept: node_modules/ and
+# cooked/ (og cook is incremental, so a new sandbox starts cooked).
+set -eu
+if [ -f bun.lock ]; then bun install --frozen-lockfile; else bun install; fi
+og="${ORIGIN_OG_BIN:-og}"
+if ! command -v "$og" >/dev/null 2>&1; then
+  echo "no og on this executor class; the first og run cooks instead"
+  exit 0
+fi
+"$og" cook .

package/archetypes/idle/LICENSES.md

@@ -0,0 +1,12 @@
+# Asset licences
+
+| File | Licence | Origin |
+|---|---|---|
+| `assets/sprites/*.png`, `assets/sprites/*.ogt` | CC0 1.0 | self-made: the orb (computed per pixel), the glow, the spark and the four motes, by `tools/make-assets.py` (standard library only, deterministic), with their import settings |
+| `assets/fx/*.ogt` | CC0 1.0 | self-made: the tap, milestone, supernova, drift and stars emitters, same script |
+| `assets/audio/*.wav` | CC0 1.0 | self-made: synthesised bells, tones and noise and the orbit's music loop, same script |
+| `assets/audio/*.ogt` | CC0 1.0 | `og sfx` presets (click, select, back, error, levelup) that `og cook` synthesises, written by the same script |
+| `assets/strings/*.ogt` | CC0 1.0 | self-made: the English and Chinese string tables |
+| `assets/fonts/NotoSansSC-subset.ttf` | SIL Open Font License 1.1 (`assets/fonts/OFL.txt`) | Noto Sans SC Regular, subset to Latin-1 and the characters of `assets/strings/zh-CN.ogt` by the same script from the project template's `assets/fonts/NotoSansSC-Regular-subset.ttf` |
+| `assets/skins/sparkorb/*` | CC0 1.0 art, SIL OFL 1.1 fonts | the engine's neon style pack (`templates/ui-kit/assets/skins/neon`, `assets/skins/sparkorb/LICENSES.md`) with this game's palette; `atlas.png` is the pack's atlas with its magenta frames turned violet by the same script |
+| `references/*/*.png` | CC0 1.0 | frames of this game recorded by `tests/frames.og.ts` |

package/archetypes/idle/README.md

@@ -0,0 +1,234 @@
+# Spark Orb — the idle archetype (2D)
+
+A glowing orb in the night. Tap it for sparks; spend them on generators
+(embers, storms, crystals, stars) that make sparks on their own and circle
+the orb as motes; every tenth of a kind doubles that kind. When a run has
+made enough, the orb can collapse into a supernova: the sparks and the
+generators go, stardust stays, and every stardust makes everything 10 %
+stronger. Close the game and come back: the orb kept going at half its
+rate while you were away.
+
+星火球：夜空里一颗发光的球。点它得到火花；用火花购买生成器（余烬、风暴、晶簇、星辰），它们会自己产出火花，并化作光点绕着星火球转；同一种每满十个，产出翻倍。一轮攒够了，星火球可以坍缩成超新星：火花和生成器都会消失，留下星尘，每一点星尘让一切产出提升 10%。关掉游戏再回来：你离开的这段时间，星火球以一半的速度继续产出。
+
+This is a complete Origin Engine project: `og run .` plays it headless,
+`og build .` makes the play page, `og test .` runs its playtests and
+`og polish .` scores them. It rebuilds the platform's retired Discover
+idle prototype on the engine: its premise (one big tap target, generators,
+prestige, progress while away) and none of its code or art.
+
+```sh
+og cook .                    # assets/ into cooked/ (og run and og build cook too)
+og run . --headless --commands "0.3:play;0.5:own:0:12;0.5:own:1:4;1.5:screenshot:orb.png;1.6:quit"
+og test .                    # tests/*.og.ts through og run --headless --commands
+og polish .                  # the playtests scored against og-taste and og-feel
+og build . --publish         # dist/: the play page as it ships
+```
+
+## What it demonstrates, and the skills it exercises
+
+- **An economy as pure functions** (og-core §1, §5): prices, rates,
+  milestones, the tap's value, the supernova's stardust and the time away's
+  credit are functions of the counts and `Tuning` in `src/numbers.ts`, so
+  the systems, the HUD and the save's merge agree on every number, and
+  `set:Tuning.<field>` retunes the curve live.
+- **Generators and prestige**: four generators at a price growing 15 % per
+  purchase, a doubling every tenth of a kind, the supernova (sparks and
+  generators reset, stardust kept, +10 % to everything per stardust), and
+  the run's card.
+- **Progress while away through og.platform's store** (og-platform-sdk
+  §1–§4): the save (`orb`) is written at the revision read every 10 s of
+  play, on pause, on quitting to the title and after a supernova; on launch
+  it is read back and the time away credited at half the rate (capped at
+  eight hours) with a welcome back; a write refused as stale (another
+  device played meanwhile) is read again and the save with more lifetime
+  sparks kept and written back. The time away is the host's to give: the
+  save carries `og.platform.now` when it was written, and the store
+  answer's `time` (the host's clock, as host input like a key press) less
+  that is how long the game was closed.
+- **Big numbers in the locale's words** (og-i18n §1–§5): `big` in
+  `src/numbers.ts` reads the unit size and the units from the string
+  tables, so English groups by thousands (`9,999`, `12.3K`, `1.20M`,
+  `4.56e15`) and Chinese by ten-thousands (`12.3万`, `1.23亿`, `4.56亿亿`);
+  `{n, number}` groups the small ones. Every string is a key of
+  `assets/strings/en.ogt` and `zh-CN.ogt`; the Chinese font is Noto Sans SC
+  subset to exactly the table's characters.
+- **A satisfying tap** (og-feel §5–§7, §9): the orb squashes and flashes,
+  the sparks made rise from where the finger landed, a burst of sparks is
+  thrown out, and the chime climbs a quarter tone a tap through a quick run
+  of taps (twelve at most), the number turning gold and bigger from the
+  eighth. A
+  purchase floats the rate it added from the ring its mote joins; a
+  milestone flings a ring of sparks, punches the camera and plays a
+  fanfare; the supernova bursts 200 sparks, holds the world 10 ticks,
+  shakes and punches it.
+- **og.ui counters on the tokens** (og-ui §2–§6, og-taste §1–§7): the
+  engine's neon pack recoloured as `assets/skins/sparkorb` (the orb's gold
+  as the one accent on night violet: a burnished amber under the buttons'
+  cream labels, the bright gold `accentInk` for gold words and icons); the wallet and the rate top left, the
+  stardust (an `og.ui.counter`) and Pause top right, the four generators
+  along the bottom (a touch-sized button each, the count of each an
+  `og.ui.counter`, the price in gold when it can be paid), the supernova's
+  progress (`og.ui.meter`) then its button, a card that shakes with the
+  error sound when its purchase is refused and bursts at a milestone,
+  `og.ui.pauseMenu`, a settings dialog, the supernova's question, its card
+  and the welcome back built from widgets, an iris between screens (a fade
+  with reduced motion).
+- **Sound** (og-audio §1–§5): the tap's chime on the ui bus (the orb is
+  the game's one big button), a purchase's bell, a milestone's arpeggio,
+  the supernova's boom, the UI's sounds from `og sfx` presets, and a slow
+  72 BPM loop of pads and bells on the music bus ducked under the effects.
+
+`og polish .` (2026-10-19, og and the native addon built release from
+this checkout, load 28): taste 97, feel 94 (frame time 81: the p95 follows
+the machine's load, `tests/evidence/P2/archetypes/frame-time.md`; the
+median step and render are 2 ms each), in
+`tests/evidence/P2/archetypes/idle/` of the engine repository. Hit feedback
+is n/a: nothing here takes damage.
+
+## Rules
+
+- **Taps.** A press on the orb, Space, Enter or the pad's A makes the
+  tap's sparks: 1 (times the stardust's multiplier) plus 5 % of the rate.
+- **Generators.** 1–4, a card's button, or the pad's X on the one the
+  d-pad (or the arrows) chose buys the next one at its price.
+
+  | Generator | Makes | First price |
+  |---|---|---|
+  | Ember | 0.5 a second | 15 |
+  | Storm | 4 a second | 110 |
+  | Crystal | 26 a second | 1,200 |
+  | Star | 160 a second | 13,000 |
+
+  Each one bought makes the next 15 % dearer; every tenth of a kind
+  doubles what that kind makes. A purchase the sparks cannot cover is
+  refused and costs nothing.
+- **Supernova.** Stardust is the floor of the square root of the run's
+  sparks over 100,000 (one at 100,000, two at 400,000, three at 900,000…).
+  N, the pad's Y or the Supernova button asks; Collapse resets the sparks
+  and the generators, keeps the stardust, and shows the run's card.
+- **Away.** On launch, the save's rate times half the seconds away (at most
+  eight hours) is added, with a welcome back.
+
+Everything is deterministic: the clock is the fixed tick, the numbers are
+pure functions, the stars come from an og.Rng stream forked by name, and
+`tests/replay.og.ts` replays a run to the same hash.
+
+## How it feels
+
+| Moment | What happens | Where |
+|---|---|---|
+| a tap | the orb squashes 1.12 × 0.9 and flashes, `+n` rises from the tap (gold and bigger from the eighth quick tap), 12 sparks burst out, a bell climbing a quarter tone per quick tap | `Orb`, `Bursts`, `Voices` |
+| a purchase | the rate it adds floats up from its ring in the generator's colour, a mote joins the ring, a bright bell | `purchase`, `Motes` |
+| a refusal | the card shakes with the error sound | `hud` |
+| a milestone | `Storm ×2!` over the orb, a ring of 48 sparks, a 0.06 punch, a burst from the card, an arpeggio | `purchase`, `hud` |
+| the supernova | 200 sparks, a 10-tick hit stop, trauma 0.6, a 0.2 punch, a boom; an iris to the run's card | `nova`, `Ui` |
+| idle | the orb breathes, sparks drift up off it, motes circle on four rings at their own speeds, stars twinkle | `Orb`, `Motes`, `fx/drift.ogt`, `fx/stars.ogt` |
+
+## State
+
+| Type | Kind | What it holds |
+|---|---|---|
+| `Game` | resource | the phase, the sparks (now, this run, ever), the generators owned, stardust and supernovas, the rate and the tap's value, the counts (taps, purchases, refusals), the chosen generator, the dialogs, the time away and its credit, the save's requests and revision, sound and burst requests |
+| `Tuning` | resource | the knobs below |
+| `Prefs` | resource | the volumes, the language, reduced motion, the settings request |
+| `Orb` | the orb | its taps |
+| `Mote` | the 48 motes | the generator and the place in its ring |
+| `Burst` | the burst pools | the kind |
+| `Sfx` | one row per sound | its `Sound.*` bit, its plays |
+
+## Systems (in tick order)
+
+| System | Job |
+|---|---|
+| `Ui` | the screens, the camera for the surface, the buses, the pause and the supernova's keys, the platform's answers, the save |
+| `Orb` | taps (a press on the orb, Space, Enter, the pad's A), the orb's breath and squash |
+| `Economy` | the generators' sparks, choosing and buying, refusals, milestones, the supernova |
+| `Motes` | one mote per generator owned (twelve a kind at most) on its ring |
+| `Bursts` | fires the burst asked for this tick from its pool |
+| `Voices` | plays each requested sound once |
+
+## Tunables (`Tuning`)
+
+| Field | Default | What it changes |
+|---|---|---|
+| `emberRate`, `emberCost` … `starRate`, `starCost` | 0.5, 15; 4, 110; 26, 1,200; 160, 13,000 | each generator |
+| `costGrowth` | 1.15 | how much dearer each one bought makes the next |
+| `milestone` | 10 | every this many of a kind doubles it |
+| `tapBase`, `tapShare` | 1, 0.05 | the tap: a base, plus seconds of the rate |
+| `dustBonus`, `novaScale` | 0.1, 100,000 | stardust's worth, and the run sparks its first one needs |
+| `offlineShare`, `offlineCap` | 0.5, 28,800 s | the time away's credit |
+| `saveEvery` | 600 ticks | how often play saves |
+
+## What a Maker changes first
+
+1. **The curve**: the generators' numbers and `costGrowth` in `Tuning`;
+   `src/numbers.ts` is the whole economy.
+2. **More generators**: a name in `GENERATORS`, its strings, an icon in
+   `ICONS` (src/ui.ts), a case in `base`, a mote in `tools/make-assets.py`,
+   an `owned<n>` field.
+3. **Prestige**: `novaGain`, `dustMultiplier`.
+4. **The look**: `assets/looks/idle.ogt` (named by `GameDesc.look`) holds
+   the frame's treatment and names the skin; `extends "<slug>"` there
+   starts from a style of the catalogue (og-taste §12), and the reference
+   frames are then recorded again (`OG_FX_CAPTURE=1 og test .`). The
+   skin's palette is `assets/skins/sparkorb/skin.ogt`, the art
+   `tools/make-assets.py`: `python3 tools/make-assets.py && og cook .`.
+5. **Words and numbers**: `assets/strings/*.ogt` (a locale's `num.step`
+   and units make its big numbers); a new Chinese string needs the script
+   run again to subset the font.
+
+## Commands (for scripts and agents)
+
+| Action | Does |
+|---|---|
+| `play` | from the title to the orb, as Play does |
+| `sparks:<n>` | sets the sparks (the rise counts as made this run) |
+| `own:<generator 0-3>:<n>` | sets how many of a generator are owned |
+| `supernova` | collapses now, as Collapse does (refused under one stardust) |
+| `relaunch:<seconds>` | closes and reopens the game that much later in this process (for tests; a real launch reads the time away from the host's clock): the save read again, the time away credited |
+| `stale_save` | another device writes a save with more progress |
+| `viewport:<desktop\|phone>` | lays the UI out for a phone in portrait (390 × 844 at 3×) |
+| `language:<en\|zh-CN>` | switches the language |
+| core actions | `touch_move_to:play`, `Shop/Gen#0/Buy`…, `Nova/Supernova`, `Collapse`, `Later`, `Again`, `Collect`, `Pause`; `Space`, `Enter`, `1`–`4`, arrows, `B`, `N`, `Escape`; `gamepad:a` … |
+
+`facts` (the probe's `state()`) reports the phase, the sparks, the rate,
+the tap's value, the generators owned, stardust, supernovas, the run's and
+the lifetime's sparks, taps, purchases, refusals, saves, stale writes, the
+last time away's credit and the language. The playtests read the same
+values from the `Game` resource with `get:Game`.
+
+## Playtests (`og test .`)
+
+| File | Proves |
+|---|---|
+| `tests/flow.og.ts` | Play; clicks on the orb, Space and Enter make a spark each and a click beside it none; 1 and the card's button buy embers at 15 and 18; the embers make a spark a second; a Star too dear is refused |
+| `tests/milestone.og.ts` | the tenth Storm doubles storms (36 → 80 a second); the wallet reads `1.23M` |
+| `tests/nova.og.ts` | N asks, Not yet keeps everything, Supernova and Collapse reset the run for one stardust, the card shows the run, Ignite again runs 10 % stronger; the telemetry and the save |
+| `tests/offline.og.ts` | Escape saves; `relaunch:7200` reads it back with Continue on the title and a welcome back of 64.8K sparks for two hours at half of 18 a second; a stale write is merged, the other device's progress kept |
+| `tests/away.og.ts` | two processes over one kept store (`store: "keep"`): ten embers and two storms saved by Escape at the first run's host time; the second launches two hours later by its own clock, offers Continue and welcomes back two hours at half of 18 a second, with no relaunch command |
+| `tests/pause.og.ts` | Escape holds the orb (time scale 0); settings switch to 简体中文 and move the music; Done saves; numbers read `1.23亿` and `每秒 +2`; Resume; Quit writes the save on the title |
+| `tests/pad.og.ts` | a gamepad alone plays, taps, chooses, buys, is refused, asks for and declines the supernova, pauses and resumes |
+| `tests/phone.og.ts` | 390 × 844 at 3×: the wallet and Pause below the notch, the generators above the home bar with touch-sized buttons, taps on the orb, a card bought |
+| `tests/frames.og.ts` | the title, the orb with every kind of mote and the supernova's card match `references/<tier>/` (`OG_FX_CAPTURE=1 og test .` records them) |
+| `tests/replay.og.ts` | a run with taps, purchases and a milestone, run twice, ends on one hash |
+
+Each one fails when the behaviour it names is broken (one was broken on
+purpose and restored: `tests/evidence/P2/archetypes/break-and-restore.md`
+in the engine repository).
+
+## Assets
+
+`tools/make-assets.py` regenerates every asset byte for byte (two runs
+give the same bytes): the orb, the glow, the spark and the motes, the
+emitters, the sounds and the music, the `og sfx` preset files of the UI's
+sounds, the font subset and the skin's recoloured atlas. `LICENSES.md`
+lists them; the skin's are in `assets/skins/sparkorb/LICENSES.md`.
+
+## Known limits (engine gaps, not design)
+
+- og.ui's `idleHud` writes `Lv` and `/s` and formats numbers in English of
+  its own, and fills a 340 px panel, so this game builds its HUD from
+  widgets to keep every word and number in its tables.
+- og.ui's `counter` counts again from where it is on every change, so the
+  sparks, which change every tick, are a label; the counters show what
+  jumps (the stardust, the generators owned).

package/archetypes/idle/assets/audio/ui-close.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# og sfx's "back" preset, synthesised by og cook (the UI's close sound).
+preset "back"
+seed 0
+pitch 1
+length 1
+volume 0.8

package/archetypes/idle/assets/audio/ui-error.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# og sfx's "error" preset, synthesised by og cook (the UI's error sound).
+preset "error"
+seed 0
+pitch 1
+length 1
+volume 0.8

package/archetypes/idle/assets/audio/ui-open.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# og sfx's "select" preset, synthesised by og cook (the UI's open sound).
+preset "select"
+seed 0
+pitch 1
+length 1
+volume 0.8

package/archetypes/idle/assets/audio/ui-press.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# og sfx's "click" preset, synthesised by og cook (the UI's press sound).
+preset "click"
+seed 0
+pitch 1
+length 1
+volume 0.8

package/archetypes/idle/assets/audio/ui-success.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# og sfx's "levelup" preset, synthesised by og cook (the UI's success sound).
+preset "levelup"
+seed 0
+pitch 1
+length 1
+volume 0.8

package/archetypes/idle/assets/fonts/NotoSansSC-subset.ttf.ogt

@@ -0,0 +1,10 @@
+type import
+version 1
+---
+# Latin-1, CJK punctuation and every character of assets/strings/zh-CN.ogt (tools/make-assets.py).
+font {
+  charset latin cjk-punct
+  chars "–…。一万下与个中串为之乐买了产亮亿会位体余你停全共再减出击分切制加动升单可后和唤器回坍夜大失始字完对将小少尘已应开得态总成提收效数文新时星晶暂暴本来果标格欢段每消火点烬照燃球生用的离秒空符等简簇继续缩置花获言设语购超轮辰迎返这进部都醒重量键间音题风！（），：；？"
+  em_px 32
+  px_range 4
+}

package/archetypes/idle/assets/fonts/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/archetypes/idle/assets/fx/drift.ogt

@@ -0,0 +1,21 @@
+type particles
+version 1
+---
+# Sparks drifting up off the orb's skin, always.
+maxParticles 60
+shape sphere 1.2
+rate 14
+lifetime 1.2 2.2
+speed 0.2 0.6
+size 0.06 0.14
+sizeOverLife 0 0.4 0.3 1 1 0
+colorOverLife {
+  key 0 1 0.85 0.5 0
+  key 0.2 1 0.75 0.35 0.9
+  key 1 1 0.4 0.15 0
+}
+gravity 0 0.6 0
+noise 0.4 0.5 0.4
+texture "sprites/spark.png"
+blend additive
+render sprite 2

package/archetypes/idle/assets/fx/milestone.ogt

@@ -0,0 +1,21 @@
+type particles
+version 1
+---
+# A milestone: a ring of sparks flung out from the orb.
+maxParticles 72
+shape sphere 0.3
+spread 180
+burst 0 48
+duration 0.1
+lifetime 0.5 0.8
+speed 3 4.5
+size 0.12 0.24
+sizeOverLife 0 1 1 0
+colorOverLife {
+  key 0 1 1 0.85 1
+  key 1 1 0.55 0.2 0
+}
+drag 1.8
+texture "sprites/spark.png"
+blend additive
+render sprite 21