@pietrovich/wot-utils 0.2.3 → 0.2.5

package/README.md

@@ -1,10 +1,13 @@
 # pie-wot
 
-A CLI toolkit for World of Tanks modders. Fetches live vehicle data from the Wargaming API, manipulates DDS textures and texture atlases, and generates custom icon sets — all from the terminal, no build step required.
+A CLI toolkit for World of Tanks modders. Fetches fresh vehicle data from the Wargaming API, manipulates DDS textures 
+and texture atlases, and generates custom icon sets — all from the terminal, no build step required.
 
-The long-term goal is to make it trivial to maintain and publish a custom icon set: when new vehicles are added to the game or tank characteristics change, re-running a handful of commands should be enough to produce an updated, publish-ready set. The [PogS icon set](https://github.com/pavelmaca/WoT-PogsIconSet) by @pavelmaca serves as the reference implementation and first supported style.
+The long-term goal is to make it trivial to maintain and publish a custom icon set: when new vehicles are added to 
+the game or tank characteristics change, re-running a handful of commands should be enough to produce an updated, 
+publish-ready set. The [PogS icon set](https://github.com/pavelmaca/WoT-PogsIconSet) by @pavelmaca served as the reference implementation and first supported style.
 
-## Pre-baked ready to use sets
+## Pre-baked, ready-to-use sets
 
 If you just want the icons without running the pipeline yourself, pre-baked sets are published periodically at [pietrovich/wot-pogs-like-icon-sets](https://github.com/pietrovich/wot-pogs-like-icon-sets) and kept in sync with game updates.
 
@@ -17,7 +20,7 @@ cp .env.example .env  # add your WG_APP_ID
 
 Get a free application ID at [developers.wargaming.net](https://developers.wargaming.net/).
 
-> **Node.js ≥ 24** required.
+> **Node.js ≥ 24** recommended. May work with older versions
 
 ## Uninstall
 
@@ -47,11 +50,11 @@ pie-wot dds decode <file>         # decode a DDS texture to PNG
 pie-wot dds encode <file>         # encode a PNG to DXT5/BC3 DDS
 
 pie-wot icon dump-background      # generate per-type background images (PogS style)
-pie-wot icon render <query>       # render a vehicle icon: type background + short name label
+pie-wot icon render <query>       # render a vehicle icon (use --simple for simplified variant)
 
 pie-wot font render [font] [text] # render text as PNG using a pixel font
 
-pie-wot cache purge               # clear the local API response cache
+pie-wot cache purge               # clear the local WG API response cache
 
 pie-wot bake <script>             # run a bundled build script (see below)
 ```
@@ -111,19 +114,6 @@ npm start -- <command>
 npm start -- vehicle list
 ```
 
-### LOCAL_DEV
-
-The bundled baker scripts (`scripts/`) detect whether the `pie-wot` global binary is available and use it by default. Set `LOCAL_DEV=true` in your `.env` (or environment) to force them to use `npm start` from the local clone instead:
-
-```
-LOCAL_DEV=true
-```
-
-This is useful when iterating on the CLI itself — changes to `src/` take effect immediately without a publish/reinstall cycle.
-
-## How it works
-
-API responses are cached locally (SHA-256 keyed, no TTL) so repeated runs don't hammer the Wargaming API. DDS encode/decode uses a trimmed BC1/BC3 codec derived from [photopea/UTEX.js](https://github.com/photopea/UTEX.js). Image compositing uses [sharp](https://sharp.pixelplumbing.com/).
 
 ## Credits
 

package/dist/index.js

@@ -2227,35 +2227,6 @@ function nameText() {
   };
 }
 
-// src/lib/icons/pogs/PogsClear.ts
-var iconAligner = createAligner(PogsConstants, "bl.+", [18, 1]);
-var PogsClear = class {
-  createBaker(app) {
-    return new ImageBaker(
-      PogsConstants,
-      [barAndShield(), vehicleIcon(app, iconAligner), tierText(), nameText()]
-    );
-  }
-};
-
-// src/lib/icons/pogs/PogsColor.ts
-var iconAligner2 = createAligner(PogsConstants, "bl.+", [18, 1]);
-var PogsColor = class {
-  createBaker(app) {
-    return new ImageBaker(
-      PogsConstants,
-      [
-        gradientBackground(),
-        barAndShield(),
-        vehicleIcon(app, iconAligner2),
-        tierText(),
-        nameText()
-      ],
-      (s) => s.removeAlpha()
-    );
-  }
-};
-
 // src/lib/icons/layers/pre-rendered-background.ts
 import { readFile as readFile6 } from "fs/promises";
 import { resolve as resolve4 } from "path";
@@ -2292,8 +2263,41 @@ function preRenderedBackground(version2, flavor = "") {
   };
 }
 
+// src/lib/icons/pogs/PogsBase.ts
+var PogsBase = class {
+  version = 1;
+  createBaker(data) {
+    return new ImageBaker(
+      PogsConstants,
+      this.getBaseLayers(data)
+    );
+  }
+  getBaseLayers(_data) {
+    return [];
+  }
+};
+
+// src/lib/icons/pogs/PogsClearSimpleV1.ts
+var iconAligner = createAligner(PogsConstants, "bl.+", [18, 24]);
+var PogsClearSimpleV1 = class extends PogsBase {
+  createBaker(data) {
+    return new ImageBaker(
+      PogsConstants,
+      this.getBaseLayers(data)
+    );
+  }
+  getBaseLayers(data) {
+    return [
+      preRenderedBackground(this.version, "clear"),
+      vehicleIcon(data, iconAligner),
+      tierText(),
+      nameText()
+    ];
+  }
+};
+
 // src/lib/icons/pogs/PogsClearV1.ts
-var iconAligner3 = createAligner(PogsConstants, "bl.+", [18, "(bh - 1).+"]);
+var iconAligner2 = createAligner(PogsConstants, "bl.+", [18, "(bh - 1).+"]);
 var PogsClearV1 = class {
   version = 1;
   createBaker(app) {
@@ -2301,7 +2305,7 @@ var PogsClearV1 = class {
       PogsConstants,
       [
         preRenderedBackground(this.version, "clear"),
-        vehicleIcon(app, iconAligner3),
+        vehicleIcon(app, iconAligner2),
         tierText(),
         nameText()
       ]
@@ -2309,11 +2313,31 @@ var PogsClearV1 = class {
   }
 };
 
-// src/lib/icons/pogs/PogsClearV2.ts
-var PogsClearV2 = class extends PogsClearV1 {
+// src/lib/icons/pogs/PogsClearSimpleV2.ts
+var PogsClearSimpleV2 = class extends PogsClearSimpleV1 {
   version = 2;
 };
 
+// src/lib/icons/pogs/PogsColorSimpleV1.ts
+var iconAligner3 = createAligner(PogsConstants, "bl.+", [18, 24]);
+var PogsColorSimpleV1 = class extends PogsBase {
+  createBaker(data) {
+    return new ImageBaker(
+      PogsConstants,
+      this.getBaseLayers(data),
+      (s) => s.removeAlpha()
+    );
+  }
+  getBaseLayers(data) {
+    return [
+      preRenderedBackground(this.version, ""),
+      vehicleIcon(data, iconAligner3),
+      tierText(),
+      nameText()
+    ];
+  }
+};
+
 // src/lib/icons/layers/text-view-range.ts
 var defaultAligner3 = createAligner(PogsConstants, "br.+", [37, "bh - 1"]);
 function textViewRange(app, aligner = defaultAligner3) {
@@ -2356,17 +2380,16 @@ function textReload(app, aligner = defaultAligner4) {
   };
 }
 
-// src/lib/icons/layers/text-hull-armor.ts
-var defaultAligner5 = createAligner(PogsConstants, "br", ["r", "b - 1"]);
-function textHullArmor(app, aligner = defaultAligner5) {
+// src/lib/icons/layers/text-penetration.ts
+var defaultAligner5 = createAligner(PogsConstants, "rt", ["r", 2]);
+function textPenetration(app, aligner = defaultAligner5) {
   return async (_box, _prev, vehicle2) => {
     const profiles = await app.getStatsForBestConfig(vehicle2);
-    const hull = profiles[vehicle2.tank_id]?.armor?.hull;
-    if (hull === void 0) {
+    const text = profiles[vehicle2.tank_id]?.ammo?.[0].penetration?.[1];
+    if (text === void 0) {
       return null;
     }
-    const text = `${hull.front}*${hull.sides}*${hull.rear}`;
-    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.white);
+    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.beige);
     const { left, top } = aligner.align({ width, height });
     return {
       input: data,
@@ -2378,20 +2401,17 @@ function textHullArmor(app, aligner = defaultAligner5) {
   };
 }
 
-// src/lib/icons/layers/text-turret-armor.ts
-var defaultAligner6 = createAligner(PogsConstants, "br", ["r", "b - 8"]);
-function textTurretArmor(app, aligner = defaultAligner6) {
-  return async (_box, prev, vehicle2) => {
+// src/lib/icons/layers/text-damage.ts
+var defaultAligner6 = createAligner(PogsConstants, "rt", ["r", 9]);
+function textDamage(app, aligner = defaultAligner6) {
+  return async (_box, _prev, vehicle2) => {
     const profiles = await app.getStatsForBestConfig(vehicle2);
-    const turret = profiles[vehicle2.tank_id]?.armor?.turret;
-    if (!turret) {
+    const text = profiles[vehicle2.tank_id]?.ammo?.[0].damage?.[1];
+    if (text === void 0) {
       return null;
     }
-    const text = `${turret.front}*`;
-    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.white);
-    const offsetX = -1 * prev.meta.width + width;
-    const shifted = aligner.shift(offsetX, 0);
-    const { left, top } = shifted.align({ width, height });
+    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.beige);
+    const { left, top } = aligner.align({ width, height });
     return {
       input: data,
       raw: { width, height, channels: 4 },
@@ -2402,16 +2422,17 @@ function textTurretArmor(app, aligner = defaultAligner6) {
   };
 }
 
-// src/lib/icons/layers/text-penetration.ts
-var defaultAligner7 = createAligner(PogsConstants, "rt", ["r", 2]);
-function textPenetration(app, aligner = defaultAligner7) {
+// src/lib/icons/layers/text-hull-armor.ts
+var defaultAligner7 = createAligner(PogsConstants, "br", ["r", "b - 1"]);
+function textHullArmor(app, aligner = defaultAligner7) {
   return async (_box, _prev, vehicle2) => {
     const profiles = await app.getStatsForBestConfig(vehicle2);
-    const text = profiles[vehicle2.tank_id]?.ammo?.[0].penetration?.[1];
-    if (text === void 0) {
+    const hull = profiles[vehicle2.tank_id]?.armor?.hull;
+    if (hull === void 0) {
       return null;
     }
-    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.beige);
+    const text = `${hull.front}*${hull.sides}*${hull.rear}`;
+    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.white);
     const { left, top } = aligner.align({ width, height });
     return {
       input: data,
@@ -2423,17 +2444,20 @@ function textPenetration(app, aligner = defaultAligner7) {
   };
 }
 
-// src/lib/icons/layers/text-damage.ts
-var defaultAligner8 = createAligner(PogsConstants, "rt", ["r", 9]);
-function textDamage(app, aligner = defaultAligner8) {
-  return async (_box, _prev, vehicle2) => {
+// src/lib/icons/layers/text-turret-armor.ts
+var defaultAligner8 = createAligner(PogsConstants, "br", ["r", "b - 8"]);
+function textTurretArmor(app, aligner = defaultAligner8) {
+  return async (_box, prev, vehicle2) => {
     const profiles = await app.getStatsForBestConfig(vehicle2);
-    const text = profiles[vehicle2.tank_id]?.ammo?.[0].damage?.[1];
-    if (text === void 0) {
+    const turret = profiles[vehicle2.tank_id]?.armor?.turret;
+    if (!turret) {
       return null;
     }
-    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.beige);
-    const { left, top } = aligner.align({ width, height });
+    const text = `${turret.front}*`;
+    const { data, width, height } = await renderWithShadow("pogs4px", text, Colors.white);
+    const offsetX = -1 * prev.meta.width + width;
+    const shifted = aligner.shift(offsetX, 0);
+    const { left, top } = shifted.align({ width, height });
     return {
       input: data,
       raw: { width, height, channels: 4 },
@@ -2444,23 +2468,26 @@ function textDamage(app, aligner = defaultAligner8) {
   };
 }
 
+// src/lib/icons/pogs/max-rld-fsr-vr.ts
+function getLayers(data) {
+  return [
+    textViewRange(data),
+    textReload(data),
+    textPenetration(data),
+    textDamage(data),
+    textHullArmor(data),
+    textTurretArmor(data)
+  ];
+}
+
 // src/lib/icons/pogs/PogsColorV1.ts
-var PogsColorV1 = class {
-  version = 1;
+var PogsColorV1 = class extends PogsColorSimpleV1 {
   createBaker(data) {
     return new ImageBaker(
       PogsConstants,
       [
-        preRenderedBackground(this.version, ""),
-        vehicleIcon(data),
-        textViewRange(data),
-        textReload(data),
-        textPenetration(data),
-        textDamage(data),
-        textHullArmor(data),
-        textTurretArmor(data),
-        tierText(),
-        nameText()
+        ...this.getBaseLayers(data),
+        ...getLayers(data)
       ],
       (s) => s.removeAlpha()
     );
@@ -2472,6 +2499,24 @@ var PogsColorV2 = class extends PogsColorV1 {
   version = 2;
 };
 
+// src/lib/icons/pogs/PogsColorSimpleV2.ts
+var PogsColorSimpleV2 = class extends PogsColorSimpleV1 {
+  version = 2;
+};
+
+// src/lib/icons/pogs/PogsClearV2.ts
+var PogsClearV2 = class extends PogsClearSimpleV2 {
+  createBaker(data) {
+    return new ImageBaker(
+      PogsConstants,
+      [
+        ...this.getBaseLayers(data),
+        ...getLayers(data)
+      ]
+    );
+  }
+};
+
 // src/commands/icon/render.ts
 var CONCURRENCY = 5;
 async function renderOneToFile(vehicle2, baker, outDir) {
@@ -2480,7 +2525,7 @@ async function renderOneToFile(vehicle2, baker, outDir) {
   console.log(`${outPath} \u2014 ${info.width}\xD7${info.height}px`);
 }
 function iconRenderCommand(app) {
-  return new Command16("render").description("Render a vehicle icon with its short name label composited over a type background").argument("[query]", "tank_id (number), tag, or short_name").option("--all", "render all vehicles").option("--color", "use color variant (default)").option("--clear", "use clear variant (no color background)").option("--bg <version>", "use pre-rendered background at given version").option("--pre-rendered-bg <version>", "alias for --bg").option("--to <dir>", "output directory (default: current working directory)").option("--create", "create output directory if it does not exist").action(async (query, options) => {
+  return new Command16("render").description("Render a vehicle icon with its short name label composited over a type background").argument("[query]", "tank_id (number), tag, or short_name").option("--all", "render all vehicles").option("--color", "use color variant (default)").option("--clear", "use clear variant (no color background)").option("--simple", "use simple icon variant (no extra-data)").option("--bg <version>", "use pre-rendered background at given version").option("--pre-rendered-bg <version>", "alias for --bg").option("--to <dir>", "output directory (default: current working directory)").option("--create", "create output directory if it does not exist").action(async (query, options) => {
     try {
       if (!query && !options.all) {
         console.error("Provide a query argument or use --all to render all vehicles.");
@@ -2495,18 +2540,26 @@ Provide an existing path or add --create to create it.`);
         }
         mkdirSync2(outDir, { recursive: true });
       }
-      const bgVersion = options.bg ?? options.preRenderedBg ?? (options.clear ? "v2" : void 0);
       let builder;
       const useColor = !options.clear;
-      if (bgVersion !== void 0) {
-        const version2 = parseInt(bgVersion.replace(/\D+/g, ""), 10);
-        if (version2 === 1) {
+      const useSimple = options.simple;
+      let bgVersion = options.bg ?? options.preRenderedBg ?? "v1";
+      if (options.clear) {
+        bgVersion = "v2";
+      }
+      const version2 = parseInt(bgVersion.replace(/\D+/g, ""), 10);
+      if (version2 === 1) {
+        if (useSimple) {
+          builder = useColor ? new PogsColorSimpleV1() : new PogsClearSimpleV1();
+        } else {
           builder = useColor ? new PogsColorV1() : new PogsClearV1();
+        }
+      } else {
+        if (useSimple) {
+          builder = useColor ? new PogsColorSimpleV2() : new PogsClearSimpleV2();
         } else {
           builder = useColor ? new PogsColorV2() : new PogsClearV2();
         }
-      } else {
-        builder = useColor ? new PogsColor() : new PogsClear();
       }
       const vehicles = options.all ? await app.getVehicles() : [await app.findVehicle(query)];
       const bakers = Array.from({ length: CONCURRENCY }, () => builder.createBaker(app));
@@ -3039,17 +3092,18 @@ async function renderOneToFile2(vehicle2, baker, outDir) {
   const info = await (await baker.bake(vehicle2)).png().toFile(outPath);
   console.log(`${outPath} \u2014 ${info.width}\xD7${info.height}px`);
 }
-async function renderIcons(app, builder, buildDir, vehiclesCount) {
+async function renderIcons(app, builder, buildDir, vehiclesCount, limit) {
   const iconsDir = join10(buildDir, "icons");
   const existing = await readdir3(iconsDir).catch(() => []);
   const pngCount = existing.filter((e) => e.endsWith(".png")).length;
-  if (pngCount >= vehiclesCount) {
+  const targetCount = limit !== void 0 ? Math.min(limit, vehiclesCount) : vehiclesCount;
+  if (pngCount >= targetCount) {
     console.log(`skipping icons render \u2014 ${iconsDir} already has ${pngCount} icons`);
     return;
   }
   console.log("generating icons");
   await mkdir5(iconsDir, { recursive: true });
-  const vehicles = await app.getVehicles();
+  const vehicles = (await app.getVehicles()).slice(0, targetCount);
   const bakers = Array.from({ length: RENDER_CONCURRENCY }, () => builder.createBaker(app));
   let idx = 0;
   await Promise.all(
@@ -3114,7 +3168,7 @@ async function copyContour(outDir, buildDir) {
   await copyPngs(join10(buildDir, "icons"), contourDir);
 }
 async function pogsPipeline(app, atlasManager2, builder, options) {
-  const { srcDir, outDir, buildDir, clean, cleanAtlasDir, gameDir, prune } = options;
+  const { srcDir, outDir, buildDir, clean, cleanAtlasDir, gameDir, prune, limit } = options;
   if (clean) {
     await cleanBuild(outDir);
     if (cleanAtlasDir) {
@@ -3125,7 +3179,7 @@ async function pogsPipeline(app, atlasManager2, builder, options) {
   await decodeDds(srcDir);
   await extractAtlases(srcDir, buildDir, atlasManager2);
   const { vehiclesCount } = await warmCache(app);
-  await renderIcons(app, builder, buildDir, vehiclesCount);
+  await renderIcons(app, builder, buildDir, vehiclesCount, limit);
   await overlayIcons(buildDir);
   await replaceSuffixed(buildDir);
   await packAtlases(outDir, buildDir, atlasManager2);
@@ -3137,11 +3191,12 @@ async function pogsPipeline(app, atlasManager2, builder, options) {
 
 // src/commands/bake/bake-command.ts
 import { join as join11 } from "path";
-import { Command as Command20 } from "commander";
+import { Command as Command20, Option } from "commander";
 function resolveBakeOptions(options) {
   const srcDir = options.atlasDir ?? join11(options.out, ".atlases");
   const clean = options.clean ?? options.fresh;
   const prune = options.prune ?? options.tidy;
+  const limit = options.limit !== void 0 ? parseInt(options.limit, 10) : void 0;
   return {
     srcDir,
     outDir: options.out,
@@ -3149,26 +3204,41 @@ function resolveBakeOptions(options) {
     gameDir: options.gameDir,
     cleanAtlasDir: !options.atlasDir,
     clean,
-    prune
+    prune,
+    limit
   };
 }
 function bakeSubcommand(name, description) {
-  return new Command20(name).description(description).requiredOption("--out <dir>", "output directory for the final mod files").option("--atlas-dir <dir>", "directory with extracted atlas DDS/PNG/XML files (default: <out>/.atlases)").option("--game-dir <dir>", "WoT game directory \u2014 used to extract missing atlas files automatically").option("--clean", "wipe build artefacts before starting").option("--fresh", "alias for --clean").option("--prune", "remove intermediate build directory after completion").option("--tidy", "alias for --prune");
+  return new Command20(name).description(description).requiredOption("--out <dir>", "output directory for the final mod files").option("--atlas-dir <dir>", "directory with extracted atlas DDS/PNG/XML files (default: <out>/.atlases)").option("--game-dir <dir>", "WoT game directory \u2014 used to extract missing atlas files automatically").option("--clean", "wipe build artefacts before starting").option("--fresh", "alias for --clean").option("--prune", "remove intermediate build directory after completion").option("--tidy", "alias for --prune").addOption(new Option("--limit [n]", "render only the first N icons and stop (default N: 10)").preset("10"));
 }
 
 // src/commands/bake/all.ts
 function bakeAllCommand(app, atlasManager2) {
   return bakeSubcommand("all", "Bake all icon sets (clear + color)").action(async (options) => {
     const resolved = resolveBakeOptions(options);
+    await pogsPipeline(app, atlasManager2, new PogsClearSimpleV2(), {
+      ...resolved,
+      outDir: join12(options.out, "clear-simple"),
+      buildDir: join12(options.out, "clear-simple", ".build")
+    });
     await pogsPipeline(app, atlasManager2, new PogsClearV2(), {
       ...resolved,
-      outDir: join12(options.out, "clear"),
-      buildDir: join12(options.out, "clear", ".build")
+      outDir: join12(options.out, "clear-DMG-RLD-FSR-VR"),
+      buildDir: join12(options.out, "clear-DMG-RLD-FSR-VR", ".build"),
+      clean: false,
+      cleanAtlasDir: false
+    });
+    await pogsPipeline(app, atlasManager2, new PogsColorSimpleV1(), {
+      ...resolved,
+      outDir: join12(options.out, "color-simple"),
+      buildDir: join12(options.out, "color-simple", ".build"),
+      clean: false,
+      cleanAtlasDir: false
     });
     await pogsPipeline(app, atlasManager2, new PogsColorV1(), {
       ...resolved,
-      outDir: join12(options.out, "color"),
-      buildDir: join12(options.out, "color", ".build"),
+      outDir: join12(options.out, "color-DMG-RLD-FSR-VR"),
+      buildDir: join12(options.out, "color-DMG-RLD-FSR-VR", ".build"),
       clean: false,
       cleanAtlasDir: false
     });
@@ -3178,7 +3248,7 @@ function bakeAllCommand(app, atlasManager2) {
 // src/commands/bake/clear.ts
 function bakeClearCommand(app, atlasManager2) {
   return bakeSubcommand("clear", "Bake PogS clear icon set (no colour background)").action(async (options) => {
-    await pogsPipeline(app, atlasManager2, new PogsClearV2(), resolveBakeOptions(options));
+    await pogsPipeline(app, atlasManager2, new PogsClearSimpleV2(), resolveBakeOptions(options));
   });
 }
 
@@ -3230,7 +3300,7 @@ function extractIconAssetsCommand() {
 
 // src/index.ts
 var _version = "";
-var version = _version || "0.2.2";
+var version = _version || "0.2.4";
 config({ path: resolve6(process.env.PIE_WOT_CWD ?? process.cwd(), ".env") });
 var wgData = new WGData();
 var atlasManager = new AtlasManager();

package/package.json

@@ -5,7 +5,7 @@
   },
   "private": false,
   "repository": "github:pietrovich/wot-utils",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "CLI utilities for World of Tanks data and assets",
   "type": "module",
   "bin": {
@@ -58,5 +58,8 @@
   },
   "engines": {
     "node": ">=24.0.0"
+  },
+  "overrides": {
+    "esbuild": ">=0.28.1"
   }
 }