packArchiveUrl
packArchiveUrl(
descriptor,ref?):string
Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/registry.ts:154
Format a pack’s upstream archive URL for a given ref (or its default ref).
Parameters
Section titled “Parameters”descriptor
Section titled “descriptor”attribution
Section titled “attribution”string = ...
Attribution string (CC0 — no attribution required, but credited by courtesy).
category
Section titled “category”"terrain" | "enemy" | "playable" = ...
Gameplay category the pack fills.
displayName
Section titled “displayName”string = ...
Human-facing name for CLI listings + docs.
github
Section titled “github”{ archiveUrlTemplate: string; defaultRef: string; owner: string; repo: string; } = packGithubSourceSchema
Upstream GitHub source.
github.archiveUrlTemplate
Section titled “github.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”string = ...
Default git ref fetched when none is supplied.
github.owner
Section titled “github.owner”string = ...
GitHub owner/org.
github.repo
Section titled “github.repo”string = ...
Repository name.
"medieval-hexagon" | "adventurers" | "skeletons" = ...
Stable pack id.
packFolder
Section titled “packFolder”string = ...
Upstream addons/<packFolder>/ directory name the pack publishes under.
"tile" | "model" = ...
Asset role the pack contributes.
string
Returns
Section titled “Returns”string