@fate-app/mod-types
v2.1.0
Published
Shared TypeScript types and runtime helpers for Assistant for Fate mods — the single source of truth for the mod manifest/bundle shape, consumed by both the app and community mod authors.
Readme
@fate-app/mod-types
Shared TypeScript types and runtime helpers for Assistant for Fate mods — the single source of truth for the mod manifest/bundle shape, consumed by both the app and community mod authors.
Exports defineFateMod, getModData/setModData, validateBundleShape,
SheetSection (a live reference to the host's shared UI, requires SDK
^2.1.0+), and the vendored registry.schema.json used to validate a mod's
manifest.json.
Full author-facing documentation lives in the app repo's
docs/MOD_API.md.
Submitting a mod to the public registry: see
fate-mods's
SUBMITTING.md.
Version discipline
This package's version tracks SDK_VERSION (the FateSDK ABI, defined in
the app's src/mods/sdk.ts) — same major.minor, patch is free. A mod's
manifest.json sdk field is a semver range checked against the app's
SDK_VERSION at load time; this package (and @fate-app/mod-build) is how
you compile against a given ABI version. Don't pin a version here that
doesn't correspond to a real SDK_VERSION the app has shipped.
