@bobfrankston/wallplater 1.0.3 → 1.0.5

package/README.md

@@ -14,20 +14,41 @@ individually colourable objects) or per-part STLs.
 The manifold engine has no system dependency beyond Node and is the path
 forward; `-scad` is kept for parity/verification.
 
+## Build / install
+
+TypeScript compiled to co-located `.js` / `.d.ts` / `.map` (no `src`/`dist`
+split). `tsc` is the global install.
+
+```sh
+npm install
+npm run build        # tsc  (or: npm run watch  for tsc -w)
+```
+
+Installed globally (`npm i -g @bobfrankston/wallplater`) it exposes a
+`wallplater` command. `defaults.json` is resolved relative to the module, so it
+runs correctly from any working directory.
+
 ## Usage
 
-Requires Node 24+ (native TypeScript + ESM — run `.ts` directly). `tsc` is the
-global install; `npm run typecheck` runs `tsc --noEmit` (type-check only — this
-project runs `.ts` and never emits `.js`).
+Requires Node 24+ (ESM). Run the compiled entry:
 
 ```sh
-node index.ts ../KitchenBack.json            # manifold engine -> KitchenBack.3mf
-node index.ts ../KitchenBack.json -scad      # OpenSCAD engine (same result)
+node index.js ../KitchenBack.json          # manifold engine -> KitchenBack.3mf
+node index.js ../KitchenBack.json -scad    # OpenSCAD engine (same result)
+wallplater   ../KitchenBack.json           # if installed globally
 ```
 
 - Outputs are written next to the **config file**, named after the config's `name`.
 - Unknown flags are rejected. `-scad` (or `--scad`) selects the OpenSCAD engine.
 
+The 3MF holds up to three named, individually-selectable objects — `<name> plate`
+(filament 1), `<name> labels` (all accent text, filament 2), `<name> breaker`
+(filament 2). The filament assignment is baked in via `Metadata/model_settings.config`
+(Bambu/Orca per-object `extruder`), so the text slices in your second colour
+without manual assignment — provided the project has ≥2 filaments. The label
+objects sit flush in the plate's front-face pockets (printed front-face-down), so
+they look hidden in the viewport until coloured.
+
 ## Config
 
 Each specific config is **deep-merged over `defaults.json`** (in this
@@ -53,9 +74,10 @@ Lengths are written **CSS-style with a unit suffix**: `"0.375in"`, `"5mm"`,
 
 - `gangs[].type`: `"decora"` | `"duplex"` | `"blank"`.
 - `gangs[].screws`: `false` to omit that gang's screw holes (default true).
-- `gangs[].legend`: single label centred below the gang.
-- `gangs[].breaker`: per-gang breaker/circuit label, centred just below that
-  gang's legend (size/position from `gangBreakerSize` / `gangBreakerY`).
+- `gangs[].legend`: single label centred above the gang's opening (positioned
+  clear of the screw holes; `legendY` / `legendSize`).
+- `gangs[].breaker`: per-gang breaker/circuit label, lower-right of the opening
+  and clear of the screws (`gangBreakerY` / `gangBreakerSize`).
 - `breaker`: `{ "switch": "A8", "size": "0.375in", "inset": "0.25in" }` — the
   panel-wide breaker label in the lower-right corner. `switch` is the text;
   `size`/`inset` come from `defaults.json`, so a config usually sets only
@@ -80,8 +102,8 @@ opening is unchanged — only the labelling differs. Per gang:
 ```
 
 Rockers are spaced evenly down the opening; `left` labels are right-aligned snug
-to the opening, `right` labels left-aligned. `legend` / `header` / `rockers`
-all print in the accent colour (the `legend` object). Relevant defaults:
+to the opening, `right` labels left-aligned. `legend` / `header` / `rockers` /
+per-gang `breaker` all print in the accent colour (the **labels** object). Relevant defaults:
 `rockerSize` (3.5mm), `rockerGap` (1.5mm), `headerSize` (4mm), `headerGap`
 (5mm). Keep side labels short on multi-gang plates — the side margin is ~18 mm
 on an end/single gang but only ~6 mm between interior gangs; long labels can

package/defaults.json

@@ -2,9 +2,9 @@
   "name": "wallplate",
   "breaker": { "switch": "", "size": "0.375in", "inset": "0.25in" },
   "legendSize": "5mm",
-  "legendY": "-42mm",
-  "gangBreakerSize": "4mm",
-  "gangBreakerY": "-50mm",
+  "legendY": "39mm",
+  "gangBreakerSize": "5mm",
+  "gangBreakerY": "-39mm",
   "rockerSize": "3.5mm",
   "rockerGap": "1.5mm",
   "headerSize": "4mm",

package/geometry.js

@@ -92,10 +92,13 @@ export async function buildMeshes(cfg) {
     for (let i = 0; i < N; i++) {
         const g = cfg.gangs[i];
         const gx = gangX(i);
+        // Screw holes sit on the gang centreline at y = +/- screwSpacing/2, so
+        // labels are kept off-centreline / out of those bands: legend above the
+        // opening (legendY > 0), per-gang breaker below-right of the opening.
         if ((g.legend ?? "") !== "")
             accent.push({ txt: g.legend, size: cfg.legendSize, halign: "center", x: gx, y: cfg.legendY });
-        if ((g.breaker ?? "") !== "") // per-gang breaker, below the legend
-            accent.push({ txt: g.breaker, size: cfg.gangBreakerSize, halign: "center", x: gx, y: cfg.gangBreakerY });
+        if ((g.breaker ?? "") !== "") // per-gang breaker: lower-right of the opening
+            accent.push({ txt: g.breaker, size: cfg.gangBreakerSize, halign: "right", x: gx + openHalf, y: cfg.gangBreakerY });
         if ((g.header ?? "") !== "")
             accent.push({ txt: g.header, size: cfg.headerSize, halign: "center", x: gx, y: openTop + cfg.headerGap });
         const rk = g.rockers ?? [];

package/index.js

@@ -18,6 +18,14 @@ import { loadConfig } from "./config.js";
 import { generateScad, runOpenscad, readStl } from "./scad.js";
 import { buildMeshes } from "./geometry.js";
 import { build3mf, writeBinaryStl } from "./threemf.js";
+// Bambu object-list name: "<config> <part>"; the accent text object reads "labels".
+function partName(cfgName, label) {
+    return `${cfgName} ${label === "legend" ? "labels" : label}`;
+}
+// Filament/extruder per part: plate -> 1, all accent text -> 2.
+function partExtruder(label) {
+    return label === "plate" ? 1 : 2;
+}
 function partList(cfg) {
     const parts = [{ mode: "plate", label: "plate" }];
     if (cfg.gangs.some((g) => (g.legend ?? "") !== ""))
@@ -41,16 +49,16 @@ function runScadEngine(cfg, dir) {
     }
     else {
         const tmp = [];
-        const meshes = parts.map((p) => {
+        const objects = parts.map((p) => {
             const stl = join(dir, `_${cfg.name}_${p.label}.stl`);
             runOpenscad(cfg.openscad, scadPath, stl, p.mode);
             tmp.push(stl);
-            return readStl(stl);
+            return { name: partName(cfg.name, p.label), mesh: readStl(stl), extruder: partExtruder(p.label) };
         });
-        writeFileSync(join(dir, `${cfg.name}.3mf`), build3mf(meshes));
+        writeFileSync(join(dir, `${cfg.name}.3mf`), build3mf(objects));
         for (const t of tmp)
             unlinkSync(t);
-        console.log("  wrote", `${cfg.name}.3mf`, `(${meshes.length} objects: ${parts.map((p) => p.label).join(", ")})`);
+        console.log("  wrote", `${cfg.name}.3mf`, `(${objects.length} objects: ${objects.map((o) => o.name).join(", ")})`);
     }
 }
 async function runManifoldEngine(cfg, dir) {
@@ -66,8 +74,9 @@ async function runManifoldEngine(cfg, dir) {
             writeFileSync(join(dir, `${cfg.name}_${m.label}.stl`), writeBinaryStl(m.mesh));
     }
     else {
-        writeFileSync(join(dir, `${cfg.name}.3mf`), build3mf(meshes.map((m) => m.mesh)));
-        console.log("  wrote", `${cfg.name}.3mf`, `(${meshes.length} objects: ${meshes.map((m) => m.label).join(", ")})`);
+        const objects = meshes.map((m) => ({ name: partName(cfg.name, m.label), mesh: m.mesh, extruder: partExtruder(m.label) }));
+        writeFileSync(join(dir, `${cfg.name}.3mf`), build3mf(objects));
+        console.log("  wrote", `${cfg.name}.3mf`, `(${objects.length} objects: ${objects.map((o) => o.name).join(", ")})`);
     }
 }
 async function main() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/wallplater",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "type": "module",
   "description": "JSON-driven wall-plate generator (Decora / duplex / blank). Direct-to-3MF via manifold-3d, with an optional OpenSCAD engine.",
   "main": "index.js",

package/threemf.d.ts

@@ -2,6 +2,11 @@ export interface Mesh {
     verts: number[][];
     tris: number[][];
 }
-export declare function build3mf(meshes: Mesh[]): Buffer;
+export interface Object3mf {
+    name: string;
+    mesh: Mesh;
+    extruder?: number;
+}
+export declare function build3mf(objects: Object3mf[]): Buffer;
 export declare function writeBinaryStl(mesh: Mesh): Buffer;
 //# sourceMappingURL=threemf.d.ts.map

package/threemf.js

@@ -6,26 +6,42 @@
  *   - writeBinaryStl(): a single binary STL (used for the manifold STL path).
  */
 import { deflateRawSync } from "zlib";
+function xmlEscape(s) {
+    return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
 // ---------- multi-object 3MF (core spec, no slicer settings) ----------
-export function build3mf(meshes) {
-    // separate top-level objects (each individually colourable in Bambu), all
-    // at the same transform so the labels stay seated in the plate's pockets.
+export function build3mf(objects) {
+    // separate, named top-level objects (each individually selectable/colourable
+    // in Bambu), all at the same transform so the labels stay seated in the
+    // plate's pockets.
     let objs = "";
     let items = "";
-    meshes.forEach((m, i) => {
+    objects.forEach((o, i) => {
+        const m = o.mesh;
         const id = i + 1;
         const vs = m.verts.map((v) => `<vertex x="${v[0]}" y="${v[1]}" z="${v[2]}"/>`).join("");
         const ts = m.tris.map((t) => `<triangle v1="${t[0]}" v2="${t[1]}" v3="${t[2]}"/>`).join("");
-        objs += `  <object id="${id}" type="model"><mesh><vertices>${vs}</vertices><triangles>${ts}</triangles></mesh></object>\n`;
+        objs += `  <object id="${id}" type="model" name="${xmlEscape(o.name)}"><mesh><vertices>${vs}</vertices><triangles>${ts}</triangles></mesh></object>\n`;
         items += `  <item objectid="${id}" transform="1 0 0 0 1 0 0 0 1 128 128 0"/>\n`;
     });
     const model = `<?xml version="1.0" encoding="UTF-8"?>
 <model unit="millimeter" xml:lang="en-US" xmlns="http://schemas.microsoft.com/3dmanufacturing/core/2015/02">
+ <metadata name="Application">wallplater</metadata>
  <resources>
 ${objs} </resources>
  <build>
 ${items} </build>
 </model>
+`;
+    // Bambu/Orca per-object filament assignment lives here (read by path; not
+    // declared in [Content_Types].xml, matching how Bambu itself packages it).
+    const settings = `<?xml version="1.0" encoding="UTF-8"?>
+<config>
+${objects.map((o, i) => `  <object id="${i + 1}">
+    <metadata key="name" value="${xmlEscape(o.name)}"/>
+    <metadata key="extruder" value="${o.extruder ?? 1}"/>
+  </object>`).join("\n")}
+</config>
 `;
     const ct = `<?xml version="1.0" encoding="UTF-8"?>
 <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
@@ -42,6 +58,7 @@ ${items} </build>
         { name: "[Content_Types].xml", data: Buffer.from(ct) },
         { name: "_rels/.rels", data: Buffer.from(rels) },
         { name: "3D/3dmodel.model", data: Buffer.from(model) },
+        { name: "Metadata/model_settings.config", data: Buffer.from(settings) },
     ]);
 }
 // ---------- binary STL (single object) ----------