diff-mindustry-bundles 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aliser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# diff-mindustry-bundles
+
+A CLI utility to view missing/extra/untranslated keys between bundles (localizations) for Mindustry.
+
+# Requirements
+
+The utility is hosted on NPM, so to run it you will:
+- A JS package manager that can run packages, so `npm` (`npx`), `bun` (`bunx`), etc. 
+- Local Mindustry repository.
+
+# Usage
+
+The readme will assume usage of `bun` (`bunx`).
+
+Navigate to the Mindustry repository you've cloned locally.
+
+Then run:
+```bash
+bunx diff-mindustry-bundles <translation_bundle>
+```
+where `<translation_bundle>` is the name of a bundle you want to check (no extension), for example: `bundle_de`.
+```bash
+bunx diff-mindustry-bundles bundle_de
+```
+
+Available options:
+```bash
+Usage: diff-mindustry-bundles [options] <top-bundle> [base-bundle]
+
+A handy utility to view missing/extra/untranslated keys between bundles.
+
+Arguments:
+  top-bundle               Bundle with your localization (no extension). For
+                           example: 'bundle_ru'
+  base-bundle              Bundle to compare with. (default: "bundle")
+
+Options:
+  -V, --version            output the version number
+  --base-dir <dirpath>     Path to the directory containing Mindustry (default:
+                           ".")
+  --bundles-dir <dirpath>  Path to the directory containing bundles. Relative to
+                           the base directory. (default: "core/assets/bundles")
+  -h, --help               display help for command
+
+```

package/README.template.md

@@ -0,0 +1,29 @@
+# diff-mindustry-bundles
+
+A CLI utility to view missing/extra/untranslated keys between bundles (localizations) for Mindustry.
+
+# Requirements
+
+The utility is hosted on NPM, so to run it you will:
+- A JS package manager that can run packages, so `npm` (`npx`), `bun` (`bunx`), etc. 
+- Local Mindustry repository.
+
+# Usage
+
+The readme will assume usage of `bun` (`bunx`).
+
+Navigate to the Mindustry repository you've cloned locally.
+
+Then run:
+```bash
+bunx diff-mindustry-bundles <translation_bundle>
+```
+where `<translation_bundle>` is the name of a bundle you want to check (no extension), for example: `bundle_de`.
+```bash
+bunx diff-mindustry-bundles bundle_de
+```
+
+Available options:
+```bash
+%help_output
+```