@kugutu/compiler
v0.2.0
Published
Compiles Kugutu character definitions into runtime CharBundles and CharPacks.
Maintainers
Readme
@kugutu/compiler
Headless compiler for Kugutu — turns
character source documents into runtime charbundles, composed SVG assets, and
single-file charpacks. This is the library behind
@kugutu/cli; use it directly to
build characters programmatically (build scripts, servers, agents).
npm install @kugutu/compilerAPI
buildCharacterBundle(document)— compile aCharacterDefinitioninto aCharBundlecomposeCharacterSvg(document, svgText, options?)— bake part selections/transforms into the SVGbuildCharacterPack(document, svgText, options?)— produce a single-fileCharPacklintCharacter(document, svgText?)— authoring diagnostics (missing nodes, invisible parts, …)
import { buildCharacterPack } from "@kugutu/compiler";
const pack = buildCharacterPack(characterDefinition, svgText);
await writeFile("mascot.charpack", JSON.stringify(pack));Types and validators come from
@kugutu/schema; the pack is
rendered by
@kugutu/runtime-web.
