Files

T

archvillainette 0de1c1e280 feat(nwsync): emit blobs and per-artifact NSYM, assemble merged manifests

Adds `crucible nwsync emit` and `crucible nwsync assemble`, the split
replacement for upstream nwn_nwsync_write, which cannot be used because it
wants every hak, the TLK and the module present in one run on one disk.

emit explodes one artifact — a .hak/.erf or a loose file such as the TLK —
into NWSync blobs (NWCompressedBuffer framing, magic NSYC, zstd) plus a NSYM
v3 manifest describing only that artifact, with the same .json sidecar
upstream writes. Blob names are the sha1 of the uncompressed bytes, restypes
nss/ndb/gic are always skipped, an unresolvable restype is a hard error, a
resource over 15 MB fails closed, and no latest or .origin file is ever
written.

assemble merges the per-artifact manifests into one, reading no bulk data.
The merge rule is resref shadowing, not concatenation: a resref present in
more than one artifact resolves to the earliest artifact in --order, the way
the game resolves it. It refuses to merge across mismatched emitter versions,
and takes --group-id from the caller (1 current, 2 testing; 0 is absent).

Refs #53.

2026-07-29 12:12:22 +02:00

4.8 KiB

Raw Blame History

Crucible command surface

internal/dispatch.Registry is the single source of truth for Crucible's builders, visible commands, descriptions, help, and hidden compatibility aliases.

Visible commands

Builder	Command	Purpose
`hak`	`build`	Build configured HAK archives and their manifest.
`hak`	`manifest`	Apply a generated HAK list to module source.
`module`	`build`	Build the module and configured project outputs.
`module`	`extract`	Extract built archives into configured source trees.
`module`	`validate`	Validate project layout, config, and source inventory.
`module`	`compare`	Compare source content with built archives.
`module`	`manifest`	Apply a generated HAK list to module source.
`topdata`	`validate`	Validate topdata source and canonical JSON compatibility.
`topdata`	`build`	Compile topdata and refresh the configured package.
`topdata`	`package`	Package cached outputs into HAK and TLK files.
`topdata`	`compare`	Compare current output with a fresh native build.
`topdata`	`convert`	Convert between 2DA and native JSON/module formats.
`wiki`	`build`	Render wiki page drafts from compiled topdata.
`wiki`	`deploy`	Deploy generated wiki pages to NodeBB.
`assets`	`compile`	Compile ASCII `.mdl` models to binary in place.
`assets`	`convert`	Convert textures to/from NWN DDS (flips vertically).
`assets`	`upscale`	Upscale textures through an installed backend.
`assets`	`check-mdl`	Report uncompiled ASCII `.mdl` and model-name mismatches.
`assets`	`fix-mdl`	Lowercase `.mdl` names and rewrite model identity to match.
`assets`	`check-dupes`	Report runtime-name (basename) collisions across dirs.
`assets`	`clean-dupes`	Delete clean-tree files whose basename collides with primary.
`depot`	`status`	Report referenced-vs-present drift against a backend.
`depot`	`push`	Upload referenced-but-absent blobs from a local depot.
`depot`	`verify`	Existence sweep plus sampled download re-hash.
`depot`	`get`	Fetch one blob with sha re-verify.
`depot`	`pull`	Incremental verified pull of every referenced blob.
`nwsync`	`emit`	Explode one artifact into NWSync blobs plus its own NSYM manifest.
`nwsync`	`assemble`	Merge per-artifact NSYM manifests into one merged manifest.

depot status and depot get pick their backend either with --out DIR, a depot tree on disk, or with --target bunny|cdn, a remote backend. The two flags are mutually exclusive.

nwsync emit runs where an artifact is born (a .hak/.erf, or a loose file such as the TLK); nwsync assemble runs at module release and reads only the small per-artifact manifests. --order lists artifact names highest priority first: a resref in more than one artifact resolves to the earliest one, the way the game resolves it. --group-id is per channel — 1 is current, 2 is testing, and 0 leaves the field out of the sidecar.

Hidden compatibility aliases

Existing scripts may continue using these names indefinitely. They are accepted but omitted from routine help and the interactive menu:

Builder	Hidden alias	Implementation
`hak`	`build-haks`	`build-haks`
`hak`	`apply-hak-manifest`	`apply-hak-manifest`
`module`	`build-module`	module-only `build-module`
`module`	`apply-hak-manifest`	`apply-hak-manifest`
`topdata`	`validate-topdata`	`validate-topdata`
`topdata`	`build-topdata`	`build-topdata`
`topdata`	`build-top-package`	`build-top-package`
`topdata`	`compare-topdata`	`compare-topdata`
`topdata`	`convert-topdata`	`convert-topdata`
`depot`	`--target local`	`--out $DEPOT_DIR` on `status`/`get`
`wiki`	`build-wiki`	`build-wiki`
`wiki`	`deploy-wiki`	`deploy-wiki`

module build-module deliberately retains its narrower module-only behavior; it is not redirected to the broader module build.

Global commands

crucible help | -h          usage + builder list
crucible version | -V       build version
crucible list               name<TAB>binary<TAB>summary
crucible config [args]      inspect and validate effective configuration
crucible changelog [args]   generate a release changelog

HAK build options

crucible hak build
  [--hak <hak-name> ...]
  [--archive <archive-name> ...]
  [--source-manifest <path>]
  [--content-addressed-root <path>]
  [--plan-only]
  [--quiet|--verbose|--debug]

When a source manifest contains asset_sources, pass --content-addressed-root <directory>. Crucible resolves each declared SHA-256 under sha256/<first-two>/<next-two>/<full-sha256> and verifies streamed bytes while writing selected HAK archives. Authored .bmu files are ordinary assets and require no conversion pipeline.

4.8 KiB Raw Blame History