fw-mods [--path <mods-directory>]
sh
Command API
The published package provides the fw-mods executable. With Yarn, it can be run without a global installation through yarn dlx @sabinmarcu/foreverwinter.
fw-mods
Opens the interactive mod manager. With no --path, it attempts automatic detection and prompts for a directory if no candidate is found.
fw-mods install
fw-mods install [--path <mods-directory>] <archive>
sh
Inspects and installs complete triplets from <archive>. The archive argument is required. --path can be placed before or after install.
--path <mods-directory>
Selects an existing directory instead of relying on automatic detection. It may be supplied once for either command. A missing value, a second --path, or a path that is not a directory is an error.
Errors and unsupported input
Only install is accepted as an explicit command. An unrecognized command or option produces an error. Passing install without exactly one archive produces this usage message:
Usage: fw-mods install [--path <mods-directory>] <archive>
text
The archive path must exist, refer to a file, and use a supported extension. A supplied mods path must resolve to a directory. Archive contents that do not meet the complete-triplet rules are not installed.
Table of contents