packDescriptor
packDescriptor(
id):object
Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/registry.ts:141
Look up a pack descriptor by id, or throw a clear error listing the valid ids.
Uses Object.hasOwn so an id equal to an Object.prototype member can’t
return an inherited value.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”attribution
Section titled “attribution”attribution:
string
Attribution string (CC0 — no attribution required, but credited by courtesy).
category
Section titled “category”category:
"terrain"|"enemy"|"playable"
Gameplay category the pack fills.
displayName
Section titled “displayName”displayName:
string
Human-facing name for CLI listings + docs.
github
Section titled “github”github:
object=packGithubSourceSchema
Upstream GitHub source.
github.archiveUrlTemplate
Section titled “github.archiveUrlTemplate”archiveUrlTemplate:
string
Archive-URL template with {owner}/{repo}/{ref} placeholders. Kept per
descriptor (not global) so a pack hosted differently can override it.
github.defaultRef
Section titled “github.defaultRef”defaultRef:
string
Default git ref fetched when none is supplied.
github.owner
Section titled “github.owner”owner:
string
GitHub owner/org.
github.repo
Section titled “github.repo”repo:
string
Repository name.
id:
"medieval-hexagon"|"adventurers"|"skeletons"
Stable pack id.
packFolder
Section titled “packFolder”packFolder:
string
Upstream addons/<packFolder>/ directory name the pack publishes under.
role:
"tile"|"model"
Asset role the pack contributes.