BootstrapKayKitAssetsOptions

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:95

Inputs to bootstrapKayKitAssets.

Properties

edition?

readonly optional edition?: "free" | "extra"

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:104

Pack edition (default free). extra requires source.kind === 'zip'.

---

fetchedAt?

readonly optional fetchedAt?: string

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:125

Reproducible timestamp written into the integrity sidecar. Default new Date().toISOString().

---

force?

readonly optional force?: boolean

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:110

When true, the destination is wiped before mirroring. When false (default), an existing non-empty target throws unless its sidecar matches the requested edition.

---

githubSource?

readonly optional githubSource?: object

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:143

GitHub archive source for the pack (RFC0-10). Defaults to the KayKit Medieval Hexagon repo. Pass a pack descriptor’s github to fetch a different pack’s archive. Only used when source.kind === 'github'.

archiveUrlTemplate

readonly archiveUrlTemplate: string

defaultRef

readonly defaultRef: string

owner

readonly owner: string

repo

readonly repo: string

---

includeSourceFormats?

readonly optional includeSourceFormats?: boolean

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:115

Include .fbx, .fbx(unity), .obj, .mtl files. Default false — only .gltf, .bin, and PNG textures are mirrored.

---

layout?

readonly optional layout?: KayKitUpstreamLayout

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:137

Target upstream layout (RFC0-10). Defaults to the edition-derived KayKit Medieval Hexagon layout. Pass a characterPackLayout(...) to bootstrap a character pack (Adventurers/Skeletons) instead. When set, detection and mirroring use THIS layout rather than the medieval-hexagon detection list.

---

libraryVersion?

readonly optional libraryVersion?: string

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:130

Override for the integrity sidecar’s libraryVersion field. Defaults to the value resolved from the closest package.json.

---

out

readonly out: string

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:102

Consumer’s asset root. The bootstrap step writes <out>/addons/kaykit_medieval_hexagon_pack/... under this folder.

---

outRoot?

readonly optional outRoot?: string

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:120

Optional jail root for out resolution. Defaults to process.cwd(). The bootstrap function refuses to write outside this root.

---

source

readonly source: BootstrapKayKitAssetsSource

Defined in: packages/declarative-hex-worlds/src/cli/commands/bootstrap/core.ts:97

Where to fetch the upstream source tree from.