@rpgm-tools/neo-angband-content 0.11.0

package/LICENSE.md

@@ -0,0 +1,43 @@
+# License
+
+Neo Angband is a derivative work of Angband and retains upstream's dual
+license, as the Angband project asks of its variants (see
+`reference/docs/copying.rst`, which remains the authoritative statement for
+the original code and its assets).
+
+Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke, and the
+Angband contributors; port code copyright (c) 2026 the Neo Angband
+contributors.
+
+This work is free software; you can redistribute it and/or modify it under
+the terms of either:
+
+a) the GNU General Public License as published by the Free Software
+   Foundation, version 2, or
+
+b) the "Angband licence":
+   This software may be copied and distributed for educational, research,
+   and not for profit purposes provided that this copyright and statement
+   are included in all such copies. Other copyrights may also apply.
+
+## Assets
+
+Asset licenses under `reference/` vary and are NOT all dual-licensed as
+above; see `reference/docs/copying.rst` for the full statements, and
+`packages/web/public/tiles/CREDITS.md` for the four tile packs this port
+actually bundles and the terms each one is bundled under.
+
+The Adam Bolt tiles (any purpose, with or without modification) and David
+Gervais tiles (CC BY 3.0, attribution given in that CREDITS.md) are available
+to tile packs under their own terms. The Shockbolt tile set is a distinct
+case and is **not** bundled: its license grants fee-free distribution *with*
+Angband but withholds modification without the author's permission, and
+withholds use with "other games or projects" absent explicit permission —
+so whether this port may carry it turns on a question only the author can
+settle. CREDITS.md states the grants and the prohibitions in full.
+
+## Mods
+
+Declarative content packs and tile packs are independent works and may be
+licensed as their authors choose. Distributed scripted plugins are safest
+treated as GPLv2 derivatives. See `docs/MODS.md`.

package/README.md

@@ -0,0 +1,65 @@
+# @rpgm-tools/neo-angband-content
+
+Angband 4.2.6's gamedata, compiled to the schema-validated pack format
+[Neo Angband](https://github.com/neostryder/neo-angband) boots from — plus the
+compiler that produced it.
+
+```bash
+npm install @rpgm-tools/neo-angband-content
+```
+
+`@rpgm-tools/neo-angband-core` is the rules and holds no content: it can roll dice, run
+the effect interpreter and read a save, but it cannot generate a populated level
+without a pack handed to it. This is that pack.
+
+## The base game is pack zero
+
+The gamedata is not special-cased anywhere. `monster.txt`, `object.txt`,
+`terrain.txt` and the rest go through the **same pipeline any mod's content goes
+through**, and come out as the same JSON records with the same schema. That is
+what makes a total conversion possible by construction rather than by permission:
+a mod that replaces every record is doing what the base game already does.
+
+## What is in the tarball
+
+| Path | What it holds |
+| --- | --- |
+| `pack/` | 45 compiled JSON files — the content itself, which is what most consumers want |
+| `dist/` | The compiler: `compileGamedata`, the line parser, and the per-file specs |
+
+```ts
+import monsters from "@rpgm-tools/neo-angband-content/pack/monster.json" with { type: "json" };
+```
+
+To recompile from upstream's text files — which needs an Angband checkout, not
+shipped here:
+
+```ts
+import { compileGamedata, gamedataSpecs } from "@rpgm-tools/neo-angband-content";
+```
+
+## Exactness is the whole point
+
+The compiler is not a convenient reader. It is checked against upstream's own
+parser (`reference/src/parser.c`) directive by directive, and the pack is checked
+back against the text it came from — a field the compiler drops silently is the
+failure mode that matters, because the game then plays subtly differently with
+nothing to see. Those checks are `data-exactness.test.ts` and the
+`*.upstream.test.ts` files in `src/`.
+
+## Versioning
+
+The pack moves with the engine and carries the game's version, not Angband's.
+`PARITY_BASELINE` in `@rpgm-tools/neo-angband-core` is the upstream release this content
+was compiled from and moves independently.
+
+## Licence
+
+Neo Angband keeps Angband's dual licence, as the Angband project asks of its
+variants: **GNU GPL v2, or the Angband licence**, at your option. npm can only
+carry one SPDX identifier, so the manifest says `GPL-2.0-only` — the more
+restrictive of the two. The full text of both is in [LICENSE.md](LICENSE.md).
+
+The gamedata in `pack/` is Angband's, by Ben Harrison, James E. Wilson, Robert A.
+Koeneke and the Angband contributors. The compiler and the pack format are by
+neostryder / RPGM Tools.

package/dist/compile.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Gamedata compiler CLI.
+ *
+ * Reads reference/lib/gamedata/<file>.txt (Angband 4.2.6, the read-only
+ * source of truth) and emits packages/content/pack/<file>.json plus a
+ * pack manifest. Run from the built output: `pnpm --filter
+ * @rpgm-tools/neo-angband-content compile` (or `node dist/compile.js`).
+ */
+export declare function main(): void;
+//# sourceMappingURL=compile.d.ts.map

package/dist/compile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../src/compile.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAiBH,wBAAgB,IAAI,IAAI,IAAI,CA4B3B"}

package/dist/compile.js

@@ -0,0 +1,42 @@
+/**
+ * Gamedata compiler CLI.
+ *
+ * Reads reference/lib/gamedata/<file>.txt (Angband 4.2.6, the read-only
+ * source of truth) and emits packages/content/pack/<file>.json plus a
+ * pack manifest. Run from the built output: `pnpm --filter
+ * @rpgm-tools/neo-angband-content compile` (or `node dist/compile.js`).
+ */
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { compileGamedata } from "./records.js";
+import { gamedataSpecs } from "./specs/index.js";
+export function main() {
+    const here = path.dirname(fileURLToPath(import.meta.url));
+    const contentRoot = path.resolve(here, "..");
+    const repoRoot = path.resolve(contentRoot, "..", "..");
+    const gamedataDir = path.join(repoRoot, "reference", "lib", "gamedata");
+    const packDir = path.join(contentRoot, "pack");
+    mkdirSync(packDir, { recursive: true });
+    const files = [];
+    for (const spec of gamedataSpecs) {
+        const sourcePath = path.join(gamedataDir, `${spec.name}.txt`);
+        const text = readFileSync(sourcePath, "utf8");
+        const compiled = compileGamedata(text, spec);
+        const outName = `${spec.name}.json`;
+        writeFileSync(path.join(packDir, outName), `${JSON.stringify(compiled, null, 2)}\n`);
+        files.push(outName);
+        console.log(`${outName}: ${compiled.records.length} records`);
+    }
+    const manifest = {
+        id: "core",
+        name: "Angband",
+        version: "4.2.6",
+        engine: ">=0.1.0",
+        files,
+    };
+    writeFileSync(path.join(packDir, "manifest.json"), `${JSON.stringify(manifest, null, 2)}\n`);
+    console.log(`manifest.json: ${files.length} files`);
+}
+main();
+//# sourceMappingURL=compile.js.map

package/dist/compile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile.js","sourceRoot":"","sources":["../src/compile.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAUjD,MAAM,UAAU,IAAI;IAClB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACxE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAExC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC;QAC9D,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC;QACpC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACrF,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,KAAK,QAAQ,CAAC,OAAO,CAAC,MAAM,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,QAAQ,GAAa;QACzB,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,SAAS;QACjB,KAAK;KACN,CAAC;IACF,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAC7F,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,CAAC,MAAM,QAAQ,CAAC,CAAC;AACtD,CAAC;AAED,IAAI,EAAE,CAAC"}

package/dist/data-exactness.reader.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Independent gamedata re-parser for W5 data-exactness.
+ *
+ * Deliberately does NOT import packages/content's parseLine / compileGamedata.
+ * Line-level semantics follow reference/src/parser.c (Angband 4.2.6);
+ * record assembly follows the C init parsers' attach/repeat idioms as
+ * documented in reference/src/{parser,parse,init,mon-init,obj-init}.c.
+ *
+ * Format registration data (parser_reg format strings + which directives
+ * repeat / nest) is supplied by the caller so this module stays free of
+ * packages/content's parser implementation. Because that metadata is itself
+ * port-supplied, extractParserRegFormats() below lets the caller check the
+ * format strings back against reference/src/*.c rather than trusting them.
+ */
+export type FieldType = "int" | "uint" | "sym" | "str" | "char" | "rand";
+export interface FieldSpec {
+    readonly type: FieldType;
+    readonly name: string;
+    readonly optional: boolean;
+}
+export interface DirectiveSignature {
+    readonly directive: string;
+    readonly fields: readonly FieldSpec[];
+}
+export interface DirectiveDef {
+    readonly fmt: string;
+    readonly repeat?: boolean;
+    readonly childOf?: readonly string[];
+    /**
+     * Synthetic key that records the file order of a cross-directive repeat
+     * group. C keeps such groups in one linked list (e.g. monster_drop, built by
+     * prepending in parse_monster_drop / parse_monster_drop_base), so splitting
+     * them into per-directive arrays would lose the interleaving. There is no
+     * upstream directive of this name; the key is generated, and every generated
+     * key must be declared here so the coverage guard can see it.
+     */
+    readonly orderKey?: string;
+}
+export interface FileSpec {
+    readonly name: string;
+    readonly recordStart: string | null;
+    readonly header?: readonly string[];
+    readonly directives: readonly DirectiveDef[];
+}
+export type JsonPrimitive = string | number | boolean;
+export type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+export interface CompiledFile {
+    file: string;
+    source: string;
+    header?: JsonObject;
+    records: JsonObject[];
+}
+/**
+ * Faithful reimplementation of parse_random() from reference/src/parser.c.
+ * Validity only; the raw dice string is what gets stored.
+ */
+export declare function independentIsValidRandom(s: string): boolean;
+export declare function independentParseSignature(fmt: string): DirectiveSignature;
+interface LineValues {
+    directive: string;
+    values: Record<string, string | number>;
+}
+/**
+ * Parse one physical line. Returns null for blanks/comments.
+ * Tokenizer mirrors strtok(":") for non-str/char and rest-of-line for str.
+ */
+export declare function independentParseLine(line: string, lookup: (directive: string) => DirectiveSignature | undefined): LineValues | null;
+/** Split a flags: payload the way C does: strtok(flags, " |"). */
+export declare function splitFlagList(raw: string): string[];
+/**
+ * Compile one gamedata file text into the same JSON shape as pack/*.json.
+ * Engine is independent of packages/content/src/{parser,records}.ts.
+ */
+export declare function independentCompile(text: string, spec: FileSpec): CompiledFile;
+/**
+ * The directive of every data line in a gamedata file, in file order.
+ *
+ * Mirrors the front of parser_parse(): skip leading isspace, drop blank and '#'
+ * lines, then take the first strtok(line, ":") token (strtok skips a run of
+ * leading delimiters). Deliberately does no field parsing, so it is an
+ * independent check on the record splitter and the directive table.
+ */
+export declare function extractDirectiveSequence(text: string): string[];
+/** Every directive key that occurs in a gamedata file, with its line count. */
+export declare function extractDirectiveKeys(text: string): Map<string, number>;
+/**
+ * parse_specs() tokenizes the format string with strtok(fmt, " "), so runs of
+ * whitespace collapse and leading/trailing whitespace is insignificant.
+ */
+export declare function normalizeFormat(fmt: string): string;
+/**
+ * Every format string handed to parser_reg() in a C source file, normalized.
+ *
+ * Adjacent string literals are concatenated the way the C compiler does, so
+ * registrations wrapped across source lines (e.g. init.c's melee-critical-level)
+ * come back as the single format string parse_specs() actually sees.
+ */
+export declare function extractParserRegFormats(source: string): string[];
+export {};
+//# sourceMappingURL=data-exactness.reader.d.ts.map

package/dist/data-exactness.reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-exactness.reader.d.ts","sourceRoot":"","sources":["../src/data-exactness.reader.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzE,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAC;CAC9C;AAED,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACtD,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,SAAS,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AACnF,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEtD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AA+DD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CA6D3D;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAoBzE;AAED,UAAU,UAAU;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CACzC;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,kBAAkB,GAAG,SAAS,GAC5D,UAAU,GAAG,IAAI,CAsEnB;AAED,kEAAkE;AAClE,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAWnD;AA0ED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,YAAY,CA0F7E;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAiB/D;AAED,+EAA+E;AAC/E,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAMtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CA8BhE"}