From 7bd2fd608c062f95f8870de77d3ab0b7372f73fd Mon Sep 17 00:00:00 2001
From: Diego Marcos Segura <diego.marcos@gmail.com>
Date: Tue, 27 May 2025 10:24:18 -0700
Subject: [PATCH] Rename npm run to-spz to npm run assets:compress for
 consistency

---
 README.md                                 | 6 ++++++
 package.json                              | 2 +-
 scripts/{to-spz.js => compress-to-spz.js} | 0
 3 files changed, 7 insertions(+), 1 deletion(-)
 rename scripts/{to-spz.js => compress-to-spz.js} (100%)

diff --git a/README.md b/README.md
index ae7ee46..d2c7daa 100644
--- a/README.md
+++ b/README.md
@@ -194,3 +194,9 @@ npm run site:serve
 ## Deploy Forge website
 
 TO-DO
+
+## Compress splats
+
+To compress a splat to [spz](https://scaniverse.com/spz) run
+
+`npm run assets:compress <file or URL to ply>`
diff --git a/package.json b/package.json
index 3c7c958..e7df9fb 100644
--- a/package.json
+++ b/package.json
@@ -6,12 +6,12 @@
   "description": "An advanced 3D Gaussian Splatting renderer for THREE.js",
   "scripts": {
     "assets:clean": "node scripts/clean-assets.js",
+    "assets:compress": "node scripts/compress-to-spz.js",
     "assets:download": "node scripts/download-assets.js",
     "build": "vite build --mode production && vite build --mode dev && tsc --emitDeclarationOnly --outFile dist/forge.d.ts",
     "build:wasm": "node rust/build_wasm.js",
     "build:watch": "onchange 'src/**/*.{ts,glsl}' -- npm run build",
     "clean": "rm -rf dist/ && rm -rf node_modules/ && rm -rf rust/target/ && rm -rf rust/forge-internal-rs/pkg/ && npm run assets:clean",
-    "to-spz": "node scripts/to-spz.js",
     "dev": "npm run build && (vite --host & npm run build:watch)",
     "deploy": "node scripts/deploy.js",
     "docs": "mkdocs serve",
diff --git a/scripts/to-spz.js b/scripts/compress-to-spz.js
similarity index 100%
rename from scripts/to-spz.js
rename to scripts/compress-to-spz.js