Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceejbot/mcm-meta-helper
Cross-check translations requested by MCM Helper config with those provided by translation files.
https://github.com/ceejbot/mcm-meta-helper
skyrim skyrim-modding
Last synced: about 2 months ago
JSON representation
Cross-check translations requested by MCM Helper config with those provided by translation files.
- Host: GitHub
- URL: https://github.com/ceejbot/mcm-meta-helper
- Owner: ceejbot
- License: other
- Created: 2024-01-06T23:41:20.000Z (9 months ago)
- Default Branch: latest
- Last Pushed: 2024-02-12T06:11:50.000Z (8 months ago)
- Last Synced: 2024-06-26T00:35:11.941Z (3 months ago)
- Topics: skyrim, skyrim-modding
- Language: Rust
- Homepage:
- Size: 713 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://github.com/ceejbot/mcm-meta-helper/releases/latest), from its [NexusMods page](https://www.nexusmods.com/skyrimspecialedition/mods/108633). If you are a homebrew user:
```sh
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:
```text
$ 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]
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
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](https://rustup.rs), then run `cargo build` to build.
## License
[The Parity Public License.](https://paritylicense.com) 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.