Skip to main content

mods

Discover installed MODs, execute MOD commands with buffered or streaming output, and query registered context menu entries.

Import

import { mods } from "@hmcs/sdk";
Field Name Convention

mods.get() returns ModInfo with snake_case field names (has_main, bin_commands, asset_ids). This differs from the application info endpoint which returns camelCase field names. The field names are planned to be unified in a future release.

Functions

FunctionDescription
listReturn metadata for every MOD discovered at startup
getRetrieve a single MOD by name
executeCommandRun a MOD command and collect the buffered result
streamCommandRun a MOD command and stream real-time output events
menusReturn all context menu entries registered across installed MODs