Skip to content

BootstrapKayKitAssetsOptions

Defined in: src/cli/commands/bootstrap/core.ts:88

Inputs to bootstrapKayKitAssets.

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

Defined in: src/cli/commands/bootstrap/core.ts:97

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


readonly optional fetchedAt?: string

Defined in: src/cli/commands/bootstrap/core.ts:118

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


readonly optional force?: boolean

Defined in: src/cli/commands/bootstrap/core.ts:103

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


readonly optional includeSourceFormats?: boolean

Defined in: src/cli/commands/bootstrap/core.ts:108

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


readonly optional libraryVersion?: string

Defined in: src/cli/commands/bootstrap/core.ts:123

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


readonly out: string

Defined in: src/cli/commands/bootstrap/core.ts:95

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


readonly optional outRoot?: string

Defined in: src/cli/commands/bootstrap/core.ts:113

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


readonly source: BootstrapKayKitAssetsSource

Defined in: src/cli/commands/bootstrap/core.ts:90

Where to fetch the upstream source tree from.