README
¶
Karty SDK
The public contract between Karty tools and the game engine.
This repository contains the cartridge and level formats used by the Karty CLI and the private engine. Neither needs to import source from the other.
format/cartridge: game metadata, embedded assets, and Wasm custom sections.format/level: versioned level envelopes and modules.- Releases: SDK bundles, native hosts, browser Wasm, checksums, and signatures produced and validated by the private engine workflow.
Game developers use these artifacts through Karty. Engine source access and GitHub credentials are not required to download them.
mise run test
mise run build
Go module tags (vVERSION) version the format packages. Engine artifact tags
(sdk-vVERSION) version downloadable SDKs and hosts independently. The engine
publishes assets here; this repository does not build private engine source.
The initial public module tag v0.0.1 still needs to be published. No remote
repository, commits, tags, or releases were created by this local extraction.
The MIT license covers this repository’s source. Official engine runtime binaries are covered by the separate Karty Runtime License, allowing distribution with free and commercial games. Exported SDK bindings and templates are MIT-licensed; private engine implementation source remains proprietary.
karty.videos.v1 and video/mpeg1@1 describe separate MPEG-1 files. Catalogs
contain name-sorted IDs, bounded sizes, a file digest and 128 KiB chunk digests.
Consumers derive content/<sha256>.kvid, verify each stored chunk, and unwrap the
streaming Karty media envelope before decoding. The video bytes are not embedded
in WASM or compressed level envelopes.
karty.audio-streams.v1 and audio-stream/qoa@1 describe long-form music and
environment audio stored outside the cartridge. Music entries precede
environment entries; IDs and names are canonical within each kind. Consumers
derive content/<sha256>.kaud, verify each 64 KiB stored chunk, and unwrap the
streaming Karty media envelope before incremental QOA decoding. Streaming audio
is limited to four hours and 512 MiB of QOA payload per entry. The
codec/qoa package exposes EncodeStream, InspectStream, and StreamDecoder
for packaging and bounded playback; the existing Encode and Inspect APIs
retain the smaller one-shot sound limits.
Directories
¶
| Path | Synopsis |
|---|---|
|
codec
|
|
|
qoa
Package qoa provides bounded one-shot and incremental adapters around Karty's pinned QOA codec.
|
Package qoa provides bounded one-shot and incremental adapters around Karty's pinned QOA codec. |
|
qoi
Package qoi provides a bounded adapter around Karty's pinned QOI codec.
|
Package qoi provides a bounded adapter around Karty's pinned QOI codec. |
|
format
|
|
|
asset
Package asset defines the public, versioned processing contract shared by Karty SDK manifests, the CLI asset processors, and runtime hosts.
|
Package asset defines the public, versioned processing contract shared by Karty SDK manifests, the CLI asset processors, and runtime hosts. |
|
cartridge
Package cartridge defines bounded data embedded in a Karty game cartridge.
|
Package cartridge defines bounded data embedded in a Karty game cartridge. |
|
level
Package level defines the bounded, versioned data envelope stored in a Karty level cartridge.
|
Package level defines the bounded, versioned data envelope stored in a Karty level cartridge. |