mcm-meta-helper

mcm-meta-helper is a command-line tool for validating your MCM Helper configuration and translation files. It reports schema errors in the helper layout file config.json as well as missing and unused translation tags.

It will also look for any I4 json files in your mod and scan those for requested translations.

You can install the meta-helper by downloading a prebuilt executable from the latest release, from its NexusMods page. If you are a homebrew user:

brew tap ceejbot/tap
brew install mcm-meta-helper

Usage

The most common usage is to change your working directory to your mod directory, then run mcm-meta-helper check. The tool exits with a non-zero status if missing translations are found, so you can perhaps fail a test suite for your mod if you detect this.

You can add translation stubs to any language file missing them by running mcm-meta-helper update.

There are additional options for each command. Here is the full output of help:

$ mcm-meta-helper help
Help manage MCM Helper translation files by checking for missing or unused translations.

Can also compare your config.json file against the MCM Helper schema to report problems,
though this is unreliable at the moment because the schema is not quite right.

Usage: mcm-meta-helper [OPTIONS] <COMMAND>

Commands:
  check     Cross-check required translation strings versus the ones found in
            translation files
  copy      Copy translations from the source language file to any language file
            missing translations
  update    Update all translation files with missing translation strings and
            placeholders
  validate  Validate the mcm config json file against the MCM helper schema
  help      Print this message or the help of the given subcommand(s)

Options:
  -m, --moddir <MODDIR>
          The mod directory containing the mod to analyze
          [default: .]

  -v, --verbose
          Print out more information as the tool runs

  -q, --quiet
          Print out only very important information

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Hacking

This is a Rust language project. Install the Rust tools with rustup, then run cargo build to build.

License

The Parity Public License. This license requires people who build on top of this source code to share their work with the community, too. In Skyrim modding language, this license allows "cathedral" modding, not "parlor" modding. Please see the text of the license for details.