@needle-tools/gltf-build-pipeline 0.1.0

package/make-progressive.mjs

@@ -0,0 +1,11 @@
+import { make_progressive } from './dist/transforms/needle_progressive.js';
+
+const args = process.argv;
+
+make_progressive({
+    path: args,
+    debug: args.includes("debug"),
+    useCache: args.includes("no-caching") === false,
+});
+
+

package/pack-gltf.mjs

@@ -0,0 +1,119 @@
+import glob from 'glob';
+import path from 'path';
+import { NodeIO } from '@gltf-transform/core';
+import { ALL_EXTENSIONS } from '@gltf-transform/extensions';
+import { draco } from '@gltf-transform/functions';
+import draco3d from 'draco3dgltf';
+import { ALL_EXTENSIONS as NEEDLE_EXTENSIONS } from "./dist/extensions/NEEDLE_opaque/index.js";
+import commandLineArgs from "command-line-args";
+import { NEEDLE_mesh_compression, NEEDLE_compression_texture } from './dist/extensions/index.js';
+import { existsSync, statSync } from 'fs';
+import { needle_mesh_transform } from "./dist/transforms/needle_mesh_transform.js";
+import { needle_texture_transform } from "./dist/transforms/needle_texture_transform.js";
+import { needle_animation_transform } from "./dist/transforms/needle_animation_transform.js";
+import { foreachGLTF } from './fileutils.mjs';
+import { needle_asset } from './dist/transforms/needle_asset.js';
+
+const args = process.argv;
+const showHelp = args.includes("help");
+
+const optionDefinitions = [
+    { name: 'debug', type: Boolean },
+    { name: 'toktxPath', type: String, multiple: true },
+    { name: 'file', type: String, multiple: true },
+];
+let options = undefined;
+try {
+    options = commandLineArgs(optionDefinitions);
+}
+catch (err) {
+    if (args?.includes("debug"))
+        console.log("Failed parsing commandline args:", err.message);
+    options = {
+        file: [...process.argv],
+        debug: args?.includes("debug"),
+    };
+    for (const arg of args) {
+        if (arg.includes("KTX-Software")) {
+            options.toktxPath = [arg];
+            break;
+        }
+    }
+}
+
+const toktxPaths = options?.toktxPath?.join(";");
+if (showHelp) {
+    if (!toktxPaths) {
+        console.log("You can define a toktx search path by adding --toktxPath <path> to the command line. The command may appear multiple times");
+    }
+    else console.log("Toktx path at " + toktxPaths);
+}
+
+// console.log(args);
+const debug = options?.debug ?? false;
+if (debug) {
+    console.log(options);
+}
+
+let allowCaching = true;
+if (args.includes("no-caching")) {
+    console.log("Caching is disabled")
+    allowCaching = false;
+}
+else if (showHelp)
+    console.log("Caching is enabled, use \"no-caching\" to disable it");
+
+const noToktx = args.includes("no-toktx");
+if (noToktx)
+    console.log("Using toktx is disabled");
+
+const packedFiles = new Set();
+
+async function packFile(file) {
+    if (!existsSync(file)) {
+        console.error("WARN: can not pack, file does not exist: " + file);
+        return;
+    }
+    if (debug && file.includes(".debug.")) {
+        return;
+    }
+
+    if (packedFiles.has(file)) return;
+    packedFiles.add(file);
+    console.log("→ Begin packing: " + file);
+
+    const prevSize = statSync(file).size;
+    const startTime = Date.now();
+    const io = new NodeIO()
+        .registerExtensions(ALL_EXTENSIONS)
+        .registerExtensions(NEEDLE_EXTENSIONS)
+        .registerExtensions([
+            NEEDLE_compression_texture,
+            NEEDLE_mesh_compression,
+        ])
+        .registerDependencies({
+            'draco3d.decoder': await draco3d.createDecoderModule(),
+            'draco3d.encoder': await draco3d.createEncoderModule(),
+        });
+    const document = await io.read(file);
+    document.getLogger().verbosity = 0;
+    await document.transform(
+        needle_asset(),
+        needle_texture_transform({ useCache: allowCaching, noToktx: noToktx }),
+        needle_mesh_transform({ ratio: 0.75, error: 0.0005 }),
+        needle_animation_transform(),
+        draco(),
+    );
+    if (debug) file += ".debug.glb";
+    await io.write(file, document);
+    const duration = Date.now() - startTime;
+    const sizeInBytes = statSync(file).size;
+    const filename = path.basename(file);
+
+    console.log(`← Compressing done in ${(duration / 1000).toFixed(1)} sec, ${(prevSize / 1024 / 1024).toFixed(1)} MB → ${(sizeInBytes / 1024 / 1024).toFixed(1)} MB: ${filename} at ${file}`);
+}
+
+
+foreachGLTF(process.argv, async (file) => {
+    await packFile(file);
+});

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@needle-tools/gltf-build-pipeline",
+  "version": "0.1.0",
+  "description": "Pipeline and tools for optimizing gltf files using gltf-transform and compression settings within glTF extensions",
+  "main": "index.mjs",
+  "type": "module",
+  "scripts": {
+    "start": "node index.mjs",
+    "dev": "npm-watch compile",
+    "transform": "node index.mjs",
+    "transform:make-progressive": "node make-progressive.mjs",
+    "transform:pack-gltf": "node --no-experimental-fetch pack-gltf.mjs",
+    "pack-gltf": "node --no-experimental-fetch pack-gltf.mjs",
+    "dev:pack-gltf": "npm run compile && node pack-gltf.mjs",
+    "clear-caches": "node clear-caches.mjs",
+    "compile": "tsc || exit 1"
+  },
+  "dependencies": {
+    "@gltf-transform/core": "^3.1.4",
+    "@gltf-transform/extensions": "^3.1.4",
+    "@gltf-transform/functions": "^3.1.4",
+    "@squoosh/lib": "^0.4.0",
+    "command-exists": "^1.2.9",
+    "command-line-args": "^5.2.1",
+    "draco3dgltf": "^1.5.3",
+    "glob": "^7.2.0",
+    "meshoptimizer": "^0.18.1",
+    "micromatch": "^4.0.5",
+    "ndarray": "^1.0.19",
+    "ndarray-lanczos": "^0.3.0",
+    "ndarray-pixels": "^2.0.1",
+    "p-limit": "3.1.0",
+    "semver": "^7.3.7",
+    "sharp": "^0.31.3",
+    "tmp": "^0.2.1"
+  },
+  "watch": {
+    "compile": {
+      "patterns": [
+        "src"
+      ],
+      "extensions": "ts",
+      "quiet": false
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.23",
+    "npm-watch": "^0.11.0",
+    "typescript": "^4.9.5"
+  },
+  "author": {
+    "name": "Needle",
+    "email": "help@needle.tools",
+    "url": "https://needle.tools/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/needle-tools/needle-gltf-extensions.git"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "outDir": "dist",
+        "declaration": true,
+        "moduleResolution": "NodeNext",
+        "module": "ESNext",
+        "esModuleInterop": true,
+        "skipLibCheck": true
+        
+    },
+    "include": [
+        "src/index.ts"
+    ]
+}