azeroth-shell 0.1.0 → 0.1.1

package/README.md

@@ -1,13 +1,13 @@
 # azsh
 
-Azeroth shell. A WoW Classic 1.12 text RPG that runs in the terminal, built on the same
-CMaNGOS Classic data and the same headless engine as [phonecraft](../phonecraft). No graphics,
-no browser, no build step.
+Azeroth shell. A WoW Classic 1.12 text RPG that runs in the terminal, built on
+CMaNGOS Classic data. The engine comes from another project of mine that is not released; this is its
+terminal front end. No graphics, no browser, no build step.
 
 ```
 npx azeroth-shell             # run it straight from npm
 npm install -g azeroth-shell  # or install it once, then:
-azsh                          # pick a character or roll one
+azeroth-shell                 # pick a character or roll one (azsh for short)
 ```
 
 From a checkout: `npm install -g .` or `node bin/azsh.mjs`.
@@ -114,17 +114,17 @@ Saves live in `~/.azsh/saves/`, one JSON file per character. `AZSH_HOME` moves t
 
 ## Where it comes from
 
-| Layer | Source | In this tree |
-| --- | --- | --- |
-| Engine, rules, world, quests, autopilot | phonecraft `src/engine`, `src/domain`, `src/world`, `src/quests`, `src/progression`, `src/autopilot` | copied as-is |
-| Data | phonecraft `src/data` (CMaNGOS world DB + DBC bake) | every table gzipped on disk (`src/cli/gzLoader.mjs` serves static imports), audio tables dropped |
-| Front end | new | `src/cli/` — `tui.mjs` (frame, input, dialogs), `tuiViews.mjs` (tabs), `tuiProfessions.mjs` and `tuiCompanions.mjs` (crafting, companions), `tuiFight.mjs` (live fight, autopilot), `repl.mjs` (line game and the shared verb table) |
-| Combat log wording | phonecraft `src/ui/combat/combatLogFormat.ts` | `src/cli/combatLogFormat.ts` |
-| Rotation sentences | phonecraft `src/ui/rotation/rotationEditorSentence.ts` | `src/cli/rotationText.mjs` |
-| Dungeon floor scripts (Baron Run; gauntlets, waves, escorts) | phonecraft `src/ui/live/liveStratUndead.ts`, `liveGauntletEscort.ts` | `src/cli/`, copied by `scripts/sync-phonecraft.mjs`; `tuiFloor.mjs` gives them their context |
+The engine, rules, world, quests, autopilot and data are taken as-is from a larger, unreleased project
+of mine that runs the same game with a graphical front end. The data is the CMaNGOS Classic world
+database plus a DBC bake, every table gzipped on disk (`src/cli/gzLoader.mjs` serves the static
+imports). What is new here is the terminal front end in `src/cli/`: `tui.mjs` (frame, input, dialogs),
+`tuiViews.mjs` (tabs), `tuiProfessions.mjs` and `tuiCompanions.mjs` (crafting, companions),
+`tuiFight.mjs` (live fight, autopilot) and `repl.mjs` (line game and the shared verb table). A few
+small UI modules (combat log wording, rotation sentences, dungeon floor scripts) are ported from the
+same project.
 
 Everything the player reads traces to a CMaNGOS row or a 1.12 client string. Nothing here is
-invented; see phonecraft's `AI.md` for the data rules this tree inherits.
+invented.
 
 ## Checks
 

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "azeroth-shell",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
-  "description": "Azeroth shell. A WoW Classic 1.12 text RPG for the terminal, built on CMaNGOS data. Terminal fork of phonecraft.",
-  "keywords": ["wow", "classic", "rpg", "terminal", "game", "tui", "cmangos"],
+  "description": "Azeroth shell. A WoW Classic 1.12 text RPG for the terminal, built on CMaNGOS data.",
+  "keywords": [
+    "wow",
+    "classic",
+    "rpg",
+    "terminal",
+    "game",
+    "tui",
+    "cmangos"
+  ],
   "bin": {
+    "azeroth-shell": "bin/azsh.mjs",
     "azsh": "bin/azsh.mjs"
   },
   "files": [

package/src/cli/term.mjs

@@ -9,6 +9,7 @@ import { stdin, stdout } from 'node:process';
 import { fit } from './text.mjs';
 
 const ESC = '\x1b[';
+const MIN_COLS = 60, MIN_ROWS = 20;
 
 const CSI_FINAL = { A: 'up', B: 'down', C: 'right', D: 'left', H: 'home', F: 'end', Z: 'shift-tab', P: 'f1', Q: 'f2', R: 'f3', S: 'f4' };
 const CSI_TILDE = { 1: 'home', 2: 'insert', 3: 'delete', 4: 'end', 5: 'pageup', 6: 'pagedown', 7: 'home', 8: 'end', 11: 'f1', 12: 'f2', 13: 'f3', 14: 'f4', 15: 'f5', 17: 'f6', 18: 'f7', 19: 'f8', 20: 'f9', 21: 'f10', 23: 'f11', 24: 'f12' };
@@ -64,40 +65,57 @@ export class RealTerm {
     this.isTTY = stdout.isTTY === true && stdin.isTTY === true;
     this.last = [];
   }
-  get cols() { return Math.max(60, stdout.columns || 100); }
-  get rows() { return Math.max(20, stdout.rows || 32); }
+  /** Layout size: never below the minimum the screens are laid out for (see `tooSmall`). */
+  get cols() { return Math.max(MIN_COLS, stdout.columns || 100); }
+  get rows() { return Math.max(MIN_ROWS, stdout.rows || 32); }
+  get tooSmall() { return (stdout.columns || 100) < MIN_COLS || (stdout.rows || 32) < MIN_ROWS; }
   open() {
     if (stdin.isTTY) stdin.setRawMode(true);
     stdin.setEncoding('utf8');
     stdin.resume();
-    stdout.write(`${ESC}?1049h${ESC}?25l${ESC}H${ESC}2J`);
-    this._data = (chunk) => { for (const k of decodeKeys(chunk)) this.onKey(k); };
-    this._resize = () => { this.last = []; this.onResize(); };
+    // Autowrap off: a line a terminal measures wider than we do (an ambiguous-width glyph) is clipped
+    // instead of wrapping and scrolling the whole frame out of step with `last`.
+    stdout.write(`${ESC}?1049h${ESC}?25l${ESC}?7l${ESC}H${ESC}2J`);
+    // Ctrl-L forgets what is on screen and repaints everything, to recover from a terminal that moved it.
+    this._data = (chunk) => { for (const k of decodeKeys(chunk)) { if (k === 'ctrl-l') this.refresh(); else this.onKey(k); } };
+    this._resize = () => this.refresh();
     stdin.on('data', this._data);
     stdout.on('resize', this._resize);
   }
   close() {
     stdin.off('data', this._data);
     stdout.off('resize', this._resize);
-    stdout.write(`${ESC}?25h${ESC}?1049l`);
+    stdout.write(`${ESC}0m${ESC}?7h${ESC}?25h${ESC}?1049l`);
     if (stdin.isTTY) stdin.setRawMode(false);
     stdin.pause();
   }
-  /** Paint a whole frame. Lines are fitted to the width; unchanged lines are skipped. The last column stays
-   *  blank so a terminal without deferred wrap never scrolls the frame when the bottom row is painted. */
+  refresh() { this.last = []; this.onResize(); }
+  /** Paint a whole frame. Lines are fitted to the width; unchanged lines are skipped, unless most of the frame
+   *  changed (a new screen), which repaints it all so a stale row cannot outlive a screen change. The last
+   *  column stays blank so a terminal without deferred wrap never scrolls when the bottom row is painted. */
   draw(lines) {
+    if (this.tooSmall) { this.drawTooSmall(); return; }
     const w = this.cols - 1, h = this.rows;
-    let out = '';
     const next = [];
-    for (let i = 0; i < h; i++) {
-      const line = fit(lines[i] ?? '', w);
-      next.push(line);
-      if (this.last[i] === line) continue;
-      out += `${ESC}${i + 1};1H${ESC}0m${line}`;
-    }
+    for (let i = 0; i < h; i++) next.push(fit(lines[i] ?? '', w));
+    const changed = next.filter((line, i) => this.last[i] !== line).length;
+    const full = !this.last.length || changed * 2 > h;
+    // Every row is padded to the width, so only a frame with nothing known on screen needs a clear first.
+    let out = this.last.length ? '' : `${ESC}0m${ESC}H${ESC}2J`;
+    next.forEach((line, i) => { if (full || this.last[i] !== line) out += `${ESC}${i + 1};1H${ESC}0m${line}`; });
     this.last = next;
     if (out) stdout.write(out);
   }
+  /** The screens need MIN_COLS x MIN_ROWS; a smaller terminal gets a notice instead of a frame drawn off its edge. */
+  drawTooSmall() {
+    const c = stdout.columns || 100, r = stdout.rows || 32;
+    const msg = [`Terminal is ${c}x${r}.`, `azsh needs at least ${MIN_COLS}x${MIN_ROWS}.`, 'Make the window larger.'];
+    const top = Math.max(0, Math.floor((r - msg.length) / 2));
+    let out = `${ESC}0m${ESC}H${ESC}2J`;
+    msg.forEach((m, i) => { if (top + i < r) out += `${ESC}${top + i + 1};${Math.max(1, Math.floor((c - m.length) / 2) + 1)}H${m.slice(0, c)}`; });
+    this.last = [];
+    stdout.write(out);
+  }
   /** Delay helper for real-time loops. */
   setInterval(fn, ms) { return setInterval(fn, ms); }
   clearInterval(h) { clearInterval(h); }

package/src/cli/tui.mjs

@@ -46,7 +46,7 @@ const HELP_LINES = [
   '  s (World tab)            find a thing in the world: who sells an item and where, what drops it, where an',
   '                           ore or herb grows, a dungeon entrance, an NPC. Enter travels there or opens it.',
   '  z                        sit and rest 30 s       ?               this help',
-  '  Ctrl-C / :quit           save and leave',
+  '  Ctrl-C / :quit           save and leave          Ctrl-L          repaint a garbled screen',
   '',
   'In the world',
   '  Enter on a creature starts a live fight; f fights it instantly. Enter on a quest, vendor, trainer or',