Skip to content

Release readiness coverage

This generated ledger combines the decomposed KayKit guide coverage, manifest coverage, public API treatment, visual artifacts, local reference packs, and package verification gates. Regenerate it with:

Terminal window
pnpm coverage:ledger
  • Status: passed
  • Guide pages: 19/19
  • Guide scenarios: 19
  • Guide assets: 404 unique (221 FREE, 183 EXTRA), 1108 page-level occurrences
  • Public API surfaces: 74
  • Public roles: 12
  • Visual artifacts: 70 available, 0 missing, 0 skipped
  • Local references: 4 available, 0 missing, 0 skipped
  • Release checks: 12 passed, 0 failed, 0 not run, 0 skipped
  • SimpleRPG API evidence: 74/74 represented, 40 directly executed, 9 active mode(s)
  • Manifest edition: free
  • Manifest assets: 221
  • FREE guide assets in manifest: 221/221
  • FREE guide assets missing from manifest: 0
  • EXTRA guide assets kept local-only: 183/183
  • Manifest validation: 0 error(s), 0 warning(s)
  • Guide-facing public APIs represented: 74/74
  • Direct executable helper APIs: 40
  • KayKit public treatment records asserted: 404
  • Decomposed guide pages asserted: 19
  • Missing public APIs: 0
  • Stale evidence rows: 0
ModeAPI Count
fixed-gameplay30
seeded-generation10
packaged-scenario1
executable-smoke40
blueprint-recipe4
manifest-package6
compatibility-adapter2
package-boundary3
visual-coverage26
Public APIModesPagesAssetsEvidence
analyzeHexTileRegistryexecutable-smoke130Packaged SimpleRPG usage analyzes a runtime tile registry in its executable guide API smoke.
coloredUnitAssetIdexecutable-smoke14, 16, 17, 18112Packaged SimpleRPG usage resolves a colored unit asset id in executable smoke.
createGameboardBuilderfixed-gameplay90Fixed SimpleRPG board starts from the public fluent builder.
createGameboardLayoutArchetypeRegistryexecutable-smoke, seeded-generation60Packaged SimpleRPG usage creates a layout archetype registry in executable smoke.
createGameboardLayoutFillRuleFromPieceexecutable-smoke, seeded-generation2, 5, 6, 9, 10, 15, 16, 1777Packaged SimpleRPG usage creates a piece-backed layout fill rule in executable smoke.
createGameboardPlanFromRecipeexecutable-smoke2, 7, 8, 9, 10, 11, 12, 13, 16, 1725Packaged SimpleRPG usage compiles a recipe into a concrete plan in executable smoke.
createGameboardPlanFromTilesexecutable-smoke7, 92Packaged SimpleRPG usage rebuilds a plan from explicit tiles in executable smoke.
createGameboardRuntimeFromScenariopackaged-scenario9, 180Packaged SimpleRPG usage creates a runtime facade directly from the scenario JSON.
createHexagonGameboardGridexecutable-smoke100Packaged SimpleRPG usage creates a Honeycomb hexagon grid in executable smoke.
createManifestBundleexecutable-smoke, manifest-package120Packaged SimpleRPG usage bundles the FREE manifest in executable smoke.
createGameboardBlueprintPlanexecutable-smoke, blueprint-recipe6, 100Packaged SimpleRPG usage compiles a blueprint plan in executable smoke.
createGameboardBlueprintRecipeexecutable-smoke, blueprint-recipe5, 8, 11, 130Packaged SimpleRPG usage compiles a blueprint recipe in executable smoke.
createMedievalShowcaseBlueprintRecipeexecutable-smoke, blueprint-recipe9, 130Packaged SimpleRPG usage compiles the showcase blueprint recipe in executable smoke.
createSeededGameboardPlanexecutable-smoke, seeded-generation90Packaged SimpleRPG usage builds a seeded board in executable smoke.
declareHexTileexecutable-smoke130Packaged SimpleRPG usage declares a tile for registry analysis in executable smoke.
executeGameboardInteractionCommandfixed-gameplay170SimpleRPG quest execution moves, interacts, attacks, and removes enemies through commands.
externalAssetSpawnOptionsexecutable-smoke, compatibility-adapter150Packaged SimpleRPG usage converts compatibility analysis into spawn options in executable smoke.
factionBuildingAssetIdexecutable-smoke2, 15, 16, 17108Packaged SimpleRPG usage resolves a faction building asset id in executable smoke.
flagAssetIdexecutable-smoke2, 54Packaged SimpleRPG usage resolves a faction flag asset id in executable smoke.
freeManifestexecutable-smoke, manifest-package10Packaged SimpleRPG usage reads the FREE manifest in executable smoke.
GameboardBuilder.addBridgefixed-gameplay, visual-coverage2, 7, 92Fixed SimpleRPG board places a bridge beside the harbor approach.
GameboardBuilder.addConstructionSitefixed-gameplay, visual-coverage2, 177Fixed SimpleRPG board places a staged worksite off the golden path.
GameboardBuilder.addElevationRampfixed-gameplay, visual-coverage8, 102Fixed SimpleRPG board places a ramp against an elevated tile.
GameboardBuilder.addFactionBuildingfixed-gameplay, visual-coverage2, 15, 16, 17108Fixed and packaged SimpleRPG boards place faction buildings.
GameboardBuilder.addFlagfixed-gameplay, visual-coverage2, 54Fixed SimpleRPG board places a faction flag and runtime actors use flag assets.
GameboardBuilder.addForestfixed-gameplay, seeded-generation, visual-coverage5, 6, 9, 1012Fixed and seeded SimpleRPG boards include forests and tree scatter.
GameboardBuilder.addFortificationfixed-gameplay, visual-coverage2, 16, 1711Fixed SimpleRPG board places a town wall segment with enclosure metadata.
GameboardBuilder.addHarborfixed-gameplay, seeded-generation, visual-coverage2, 5, 7, 1525Fixed and seeded SimpleRPG boards include a playable harbor/coast relationship.
GameboardBuilder.addHillfixed-gameplay, seeded-generation, visual-coverage5, 6, 9, 109Fixed and seeded SimpleRPG boards include hill terrain and decorations.
GameboardBuilder.addMountainStackfixed-gameplay, seeded-generation, visual-coverage5, 6, 8, 9, 1012Fixed, seeded, and packaged SimpleRPG boards place stacked mountains.
GameboardBuilder.addNaturefixed-gameplay, visual-coverage5, 6, 9, 1042Fixed SimpleRPG board places standalone nature assets.
GameboardBuilder.addNeutralStructurefixed-gameplay, visual-coverage2, 7, 9, 16, 1721Fixed SimpleRPG board places a neutral grain building.
GameboardBuilder.addPropfixed-gameplay, visual-coverage2, 5, 15, 16, 1735Fixed SimpleRPG quest uses a registered crate prop as a passable actor target.
GameboardBuilder.addPropClusterfixed-gameplay, visual-coverage2, 5, 15, 16, 1731Fixed SimpleRPG board places a resource-cache cluster.
GameboardBuilder.addRiverPathfixed-gameplay, visual-coverage4, 730Fixed SimpleRPG board routes a curvy waterless river through the quest road.
GameboardBuilder.addRoadPathfixed-gameplay, seeded-generation, visual-coverage3, 915Fixed, seeded, and packaged SimpleRPG boards use roads for movement routes.
GameboardBuilder.addSettlementfixed-gameplay, visual-coverage2, 16, 1796Fixed SimpleRPG board places a settlement home through the settlement alias.
GameboardBuilder.addSiegeProjectilefixed-gameplay, visual-coverage2, 171Fixed SimpleRPG board places a catapult projectile beside the town wall.
GameboardBuilder.addTransitionfixed-gameplay, visual-coverage11, 12, 131Fixed SimpleRPG board places a local-only texture transition and marks it EXTRA.
GameboardBuilder.addUnitfixed-gameplay, visual-coverage14, 16, 17, 18137Fixed SimpleRPG board places colored and neutral EXTRA unit parts.
GameboardBuilder.addUnitPresetfixed-gameplay, visual-coverage14, 15, 16, 17, 18137Fixed SimpleRPG board places a composed soldier preset.
GameboardBuilder.scatterDecorationsfixed-gameplay, seeded-generation, visual-coverage5, 6, 9, 1042Fixed and seeded SimpleRPG boards scatter decorations deterministically.
GameboardBuilder.setCoastEdgesfixed-gameplay, visual-coverage7, 1510Fixed SimpleRPG board marks the water edge as coast before adding a harbor.
GameboardBuilder.setElevationfixed-gameplay, visual-coverage8, 100Fixed SimpleRPG board raises a tile and then adds an elevation ramp.
GameboardBuilder.setTerrainfixed-gameplay, seeded-generation, visual-coverage7, 92Fixed SimpleRPG board authors a full water row and seeded generation fills terrain.
GameboardBuilder.setTileAssetfixed-gameplay, visual-coverage7, 8, 9, 105Fixed and packaged SimpleRPG boards override authored tile assets and tags.
inspectGameboardBlueprintexecutable-smoke, blueprint-recipe6, 110Packaged SimpleRPG usage inspects a blueprint in executable smoke.
listCoastGuidePermutationsexecutable-smoke7, 1510Packaged SimpleRPG usage lists coast guide permutations in executable smoke.
listKayKitAssetPublicTreatmentsexecutable-smoke10Packaged SimpleRPG usage lists every KayKit asset public treatment in executable smoke.
listKayKitGuideScenariosexecutable-smoke1, 190Packaged SimpleRPG usage lists every decomposed KayKit guide scenario in executable smoke.
listPropClusterAssetsexecutable-smoke2, 5, 15, 16, 1731Packaged SimpleRPG usage resolves prop-cluster assets in executable smoke.
listRiverCrossingGuidePermutationsexecutable-smoke4, 74Packaged SimpleRPG usage lists river crossing permutations in executable smoke.
listRiverCurvyGuidePermutationsexecutable-smoke4, 72Packaged SimpleRPG usage lists curvy river permutations in executable smoke.
listRiverGuidePermutationsexecutable-smoke4, 724Packaged SimpleRPG usage lists river permutations in executable smoke.
listRoadGuidePermutationsexecutable-smoke3, 915Packaged SimpleRPG usage lists road permutations in executable smoke.
declarative-hex-worlds manifestpackage-boundary, manifest-package120Package smoke validates the CLI manifest and packaged SimpleRPG imports together.
neutralUnitAssetIdexecutable-smoke14, 16, 17, 1825Packaged SimpleRPG usage resolves a neutral unit asset id in executable smoke.
NOTICE.mdpackage-boundary, manifest-package190Release/package audits keep KayKit attribution with the SimpleRPG packaged smoke.
package.json filespackage-boundary, manifest-package190Package audit verifies exports, files, examples, and SimpleRPG package imports.
planGameboardInteractionCommandfixed-gameplay170Fixed SimpleRPG tests plan prop interaction and enemy attack commands.
recommendExternalAssetFacingexecutable-smoke, compatibility-adapter160Packaged SimpleRPG usage recommends external asset facing in executable smoke.
selectCoastVariantexecutable-smoke7, 1510Packaged SimpleRPG usage selects a coast variant in executable smoke.
selectCoastVariantByLabelexecutable-smoke7, 1510Packaged SimpleRPG usage selects a labeled coast variant in executable smoke.
selectManifestAssetsexecutable-smoke, manifest-package120Packaged SimpleRPG usage selects manifest assets in executable smoke.
selectRiverCrossingVariantexecutable-smoke4, 74Packaged SimpleRPG usage selects a river crossing variant in executable smoke.
selectRiverVariantexecutable-smoke4, 726Packaged SimpleRPG usage selects a river variant in executable smoke.
selectRiverVariantByLabelexecutable-smoke4, 724Packaged SimpleRPG usage selects a labeled river variant in executable smoke.
selectRoadVariantexecutable-smoke3, 915Packaged SimpleRPG usage selects a road variant in executable smoke.
selectRoadVariantByLabelexecutable-smoke3, 915Packaged SimpleRPG usage selects a labeled road variant in executable smoke.
selectSpawnCoordinatesexecutable-smoke90Packaged SimpleRPG usage selects raw deterministic spawn coordinates in executable smoke.
spawnGameboardActorfixed-gameplay14, 16, 17, 18137Fixed and seeded SimpleRPG fixtures spawn player, NPC, prop, and enemy actors.
textureFileNameexecutable-smoke11, 120Packaged SimpleRPG usage resolves a texture filename in executable smoke.
validateGameboardRecipeexecutable-smoke11, 12, 131Packaged SimpleRPG usage validates a compiled recipe in executable smoke.
validateGameboardRecipeGenerationexecutable-smoke130Packaged SimpleRPG usage validates recipe generation config in executable smoke.
  • None
StatusReferencePathPurpose
availableKayKit Medieval Hexagon FREEreferences/KayKit_Medieval_Hexagon_Pack_1.0_FREEFREE source pack for guide extraction, generated assets, and manifest audits.
availableKayKit Medieval Hexagon EXTRAreferences/KayKit_Medieval_Hexagon_Pack_1.0_EXTRAPurchased local-only EXTRA pack for category and guide visual coverage.
availableKenney Castle Kitreferences/kenney_castle-kitThird-party compatibility fixture for non-hex props, structures, and warnings.
availableKayKit Adventurers FREEreferences/KayKit_Adventurers_2.0_FREEAnimated actor fixture for facing, spawn, and SimpleRPG local-asset coverage.
StatusCommandSummary
passedpnpm lintBiome lint over workspace packages, docs scripts, and generated public TypeScript surfaces.
passedpnpm typecheckStrict TypeScript validation for runtime, package tests, docs scripts, and generated examples.
passedpnpm buildNx package build including tsup ESM chunks, declarations, CLI shebang preservation, and asset copies.
passedpnpm test:ciSerialized non-browser release gate: docs contracts, API docs, assets, workspace/workflow audits, CLI smoke, expectations, unit tests, package audit, consumer smoke, and dry-run pack.
passedpnpm test:docs-contractPillar frontmatter/link audit plus README, pillar, and guide SimpleRPG executable coverage contract for 40 guide-facing helper APIs, 404 KayKit public treatment records, and 19 guide pages.
passedpnpm expectationsBehavior-drift fixtures for seeded generation, SimpleRPG quests, executable guide API smoke, movement, actor targets, patrols, mutations, and final placements.
passedpnpm docs:buildTypeDoc and VitePress documentation build with public JSDoc and guide-link validation.
passedpnpm test:consumerPacked tarball installed into a temporary app, then compiled and executed through public subpaths, examples, and the CLI bin.
passedpnpm test:visualFREE, EXTRA, SimpleRPG, Kenney Castle Kit, and KayKit Adventurers browser visual suites with screenshot quality checks.
passedpnpm showcases:promote -- --checkCurated browser screenshots match committed docs/package showcase copies and pass the shared PNG quality analyzer.
passedpnpm test:workflowsCI, Release Please, npm OIDC publish, automerge, and Dependabot workflow contract audit.
passedpnpm pack:dry-runnpm tarball dry run proving publish whitelist, FREE asset inclusion, local reference exclusion, README gallery links, KayKit attribution/NOTICE, and packaged showcase PNG quality.
StatusSourceArtifactPages
availableguidedocs/assets/kaykit-guide/montage.png1
availableguidedocs/assets/kaykit-guide/pages/page-01.png1
availableguidedocs/assets/kaykit-guide/pages/page-02.png2
availableguidedocs/assets/kaykit-guide/pages/page-03.png3
availableguidedocs/assets/kaykit-guide/pages/page-04.png4
availableguidedocs/assets/kaykit-guide/pages/page-05.png5
availableguidedocs/assets/kaykit-guide/pages/page-06.png6
availableguidedocs/assets/kaykit-guide/pages/page-07.png7
availableguidedocs/assets/kaykit-guide/pages/page-08.png8
availableguidedocs/assets/kaykit-guide/pages/page-09.png9
availableguidedocs/assets/kaykit-guide/pages/page-10.png10
availableguidedocs/assets/kaykit-guide/pages/page-11.png11
availableguidedocs/assets/kaykit-guide/pages/page-12.png12
availableguidedocs/assets/kaykit-guide/pages/page-13.png13
availableguidedocs/assets/kaykit-guide/pages/page-14.png14
availableguidedocs/assets/kaykit-guide/pages/page-15.png15
availableguidedocs/assets/kaykit-guide/pages/page-16.png16
availableguidedocs/assets/kaykit-guide/pages/page-17.png17
availableguidedocs/assets/kaykit-guide/pages/page-18.png18
availableguidedocs/assets/kaykit-guide/pages/page-19.png19
availableshowcasedocs/assets/showcases/extra-blueprint-biome-transition-showcase.png-
availableshowcasedocs/assets/showcases/extra-harbor-gameboard.png-
availableshowcasedocs/assets/showcases/free-blueprint-builder-showcase.png-
availableshowcasedocs/assets/showcases/free-guide-coasts-all-labels-rotations-water-waterless.png-
availableshowcasedocs/assets/showcases/free-guide-rivers-all-labels-rotations-water-waterless.png-
availableshowcasedocs/assets/showcases/free-guide-roads-all-labels-rotations.png-
availableshowcasedocs/assets/showcases/free-guide-scenarios-by-extracted-page.png-
availableshowcasedocs/assets/showcases/simple-rpg-fixed-completed.png-
availableshowcasedocs/assets/showcases/simple-rpg-local-third-party-assets.png-
availableshowcasedocs/assets/showcases/simple-rpg-seeded-completed.png-
availableguideNOTICE.md19
availableshowcasedocs/showcases/extra-blueprint-biome-transition-showcase.png-
availableshowcasedocs/showcases/extra-harbor-gameboard.png-
availableshowcasedocs/showcases/free-blueprint-builder-showcase.png-
availableshowcasedocs/showcases/free-guide-coasts-all-labels-rotations-water-waterless.png-
availableshowcasedocs/showcases/free-guide-rivers-all-labels-rotations-water-waterless.png-
availableshowcasedocs/showcases/free-guide-roads-all-labels-rotations.png-
availableshowcasedocs/showcases/free-guide-scenarios-by-extracted-page.png-
availableshowcasedocs/showcases/simple-rpg-fixed-completed.png-
availableshowcasedocs/showcases/simple-rpg-local-third-party-assets.png-
availableshowcasedocs/showcases/simple-rpg-seeded-completed.png-
availableguidetests/browser/__screenshots__/extra-blueprint-biome-transition-showcase.png9, 11, 13
availablescreenshottests/browser/__screenshots__/extra-guide-assets-by-public-role.png-
availablescreenshottests/browser/__screenshots__/extra-guide-scenarios-pages-02-15.png-
availablescreenshottests/browser/__screenshots__/extra-guide-scenarios-pages-16-18.png-
availableguidetests/browser/__screenshots__/extra-harbor-gameboard.png7, 15
availableguidetests/browser/__screenshots__/extra-local-all-buildings-factions-neutral-harbors.png2, 15, 17
availableguidetests/browser/__screenshots__/extra-local-all-decoration-nature-props.png5, 16
availableguidetests/browser/__screenshots__/extra-local-all-tiles-guide-and-transitions.png11, 12, 13
availableguidetests/browser/__screenshots__/extra-local-all-units-full-accent-neutral-siege.png14, 16, 17, 18
availableguidetests/browser/__screenshots__/extra-seasonal-textures.png11, 12, 13
availableguidetests/browser/__screenshots__/free-blueprint-builder-showcase.png8, 9
availablescreenshottests/browser/__screenshots__/free-catalog.png-
availableguidetests/browser/__screenshots__/free-gameboard-recipe.png8, 9
availableguidetests/browser/__screenshots__/free-generated-piece-recipe.png6
availablescreenshottests/browser/__screenshots__/free-guide-assets-by-public-role.png-
availableguidetests/browser/__screenshots__/free-guide-coasts-all-labels-rotations-water-waterless.png7
availableguidetests/browser/__screenshots__/free-guide-page-nature-stacks-buildings-props.png2, 5, 6, 8, 10
availableguidetests/browser/__screenshots__/free-guide-river-curvy-crossings-all-modes.png4
availableguidetests/browser/__screenshots__/free-guide-rivers-all-labels-rotations-water-waterless.png4, 7
availableguidetests/browser/__screenshots__/free-guide-roads-all-labels-rotations.png3
availablescreenshottests/browser/__screenshots__/free-guide-scenarios-by-extracted-page.png-
availablescreenshottests/browser/__screenshots__/free-guide-source-pages.png-
availableguidetests/browser/__screenshots__/free-seeded-gameboard.png9
availableguidetests/browser/__screenshots__/free-seeded-hex-gameboard.png10
availableguidetests/browser/__screenshots__/simple-rpg-fixed-completed.png9
availableguidetests/browser/__screenshots__/simple-rpg-local-third-party-assets.png14
availablescreenshottests/browser/__screenshots__/simple-rpg-packaged-scenario.png-
availableguidetests/browser/__screenshots__/simple-rpg-seeded-completed.png18
availablescreenshottests/browser/__screenshots__/simple-rpg-simulation-report.png-
PageScenarioEditionAssetsAPIsDocsVisualsSource Image
1page-01-overview-and-licensereference0332available docs/assets/kaykit-guide/pages/page-01.png
2page-02-buildings-props-and-factionsmixed1641622available docs/assets/kaykit-guide/pages/page-02.png
3page-03-road-variationsfree15421available docs/assets/kaykit-guide/pages/page-03.png
4page-04-river-variationsfree30722available docs/assets/kaykit-guide/pages/page-04.png
5page-05-nature-contentsfree771322available docs/assets/kaykit-guide/pages/page-05.png
6page-06-nature-usagefree42922available docs/assets/kaykit-guide/pages/page-06.png
7page-07-water-usagefree441823available docs/assets/kaykit-guide/pages/page-07.png
8page-08-taller-hex-tilesfree3623available docs/assets/kaykit-guide/pages/page-08.png
9page-09-world-design-examplefree612125available docs/assets/kaykit-guide/pages/page-09.png
10page-10-floating-islandsfree451222available docs/assets/kaykit-guide/pages/page-10.png
11page-11-biomesextra1623available docs/assets/kaykit-guide/pages/page-11.png
12page-12-alternate-texturesextra1722available docs/assets/kaykit-guide/pages/page-12.png
13page-13-transition-tilesextra1823available docs/assets/kaykit-guide/pages/page-13.png
14page-14-unitsextra137522available docs/assets/kaykit-guide/pages/page-14.png
15page-15-shipyard-harborsmixed251322available docs/assets/kaykit-guide/pages/page-15.png
16page-16-stables-and-horsesextra1551622available docs/assets/kaykit-guide/pages/page-16.png
17page-17-workshop-and-siegeextra1701922available docs/assets/kaykit-guide/pages/page-17.png
18page-18-unit-combinationsextra137622available docs/assets/kaykit-guide/pages/page-18.png
19page-19-supporters-and-attributionreference0332available docs/assets/kaykit-guide/pages/page-19.png
  • pnpm lint
  • pnpm typecheck
  • pnpm build
  • pnpm test:ci
  • pnpm test:docs-contract
  • pnpm expectations
  • pnpm docs:build
  • pnpm test:consumer
  • pnpm test:visual
  • pnpm showcases:promote -- --check
  • pnpm test:workflows
  • pnpm pack:dry-run