A plugin-based modding toolkit for Cataclysm: Dark Days Ahead.
This is the monorepo for the .devtools family of packages. You install the frontier CLI once, register plugins against it, and run them through its command line. Each plugin handles one concern, from compiling higher-level mod source to formatting and scaffolding.
The core package. On its own it manages the toolkit's plugins installed on your system, and it is the shared library every plugin builds on.
bun add -g @frmds/frontier
# register a plugin (usually automatic on install) and run it
frontier plugins add @frmds/autodoc
frontier run autodoc buildSee @frmds/frontier for more information.
Note: the core package runs on Bun v1.3 or above.
Compiles a mod written in a higher-level, composable, DRY form down into game-ready JSON:
bun add -g @frmds/autodoc
# in a mod directory containing `frontier.json5`
frontier run autodoc buildSee @frmds/autodoc for more information.
You can use @frmds/init to initialize a toolkit-compatible mod structure
The shared library of autodoc transformers, the building blocks that turn higher-level source into game-ready JSON. Import the ones you want, or pull in every transformer at once, and reference them in your mod's autodoc configuration:
import { ALL_TRANSFORMERS, MATH_TRANSFORMER } from "@frmds/transformers";See @frmds/transformers for more information.
Formats a directory of JSON files with the formatter Cataclysm: Dark Days Ahead ships with, applying the game's own style. It needs a registered game install.
bun add -g @frmds/format
# find install locations on the system
frontier game discover
# format the current directory
frontier run formatSee @frmds/format for more information.
Scaffolds a toolkit-compatible mod in the current directory:
bun add -g @frmds/init
# scaffold a new mod where you want it to live
frontier run initSee @frmds/init for more information.
MIT
