@playcanvas/splat-transform 0.5.3 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,12 +1,22 @@
1
1
  # SplatTransform - 3D Gaussian Splat Converter
2
2
 
3
- SplatTransform is an open source CLI tool for reading gaussian splat PLY files and writing them to PLY, Compressed PLY, CSV, and SOGS format.
3
+ [![NPM Version](https://img.shields.io/npm/v/@playcanvas/splat-transform.svg)](https://www.npmjs.com/package/@playcanvas/splat-transform)
4
+ [![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/splat-transform)](https://npmtrends.com/@playcanvas/splat-transform)
5
+ [![License](https://img.shields.io/npm/l/@playcanvas/splat-transform.svg)](https://github.com/playcanvas/splat-transform/blob/main/LICENSE)
4
6
 
5
- Multiple files may be combined and transformed before being written to the output.
7
+ | [User Guide](https://developer.playcanvas.com/user-manual/gaussian-splatting/editing/splat-transform/) | [Blog](https://blog.playcanvas.com/) | [Forum](https://forum.playcanvas.com/) | [Discord](https://discord.gg/RSaMRzg) |
8
+
9
+ SplatTransform is an open source CLI tool for converting and editing Gaussian splats. It can:
10
+
11
+ 📥 Read PLY, Compressed PLY, SPLAT, KSPLAT formats
12
+ 📤 Write PLY, Compressed PLY, CSV, and SOGS formats
13
+ 🔗 Merge multiple splats
14
+ 🔄 Apply transformations to input splats
15
+ 🎛️ Filter out Gaussians or spherical harmonic bands
6
16
 
7
17
  ## Installation
8
18
 
9
- First install the package globally:
19
+ Install or update to the latest version:
10
20
 
11
21
  ```bash
12
22
  npm install -g @playcanvas/splat-transform
@@ -15,7 +25,7 @@ npm install -g @playcanvas/splat-transform
15
25
  ## Usage
16
26
 
17
27
  ```bash
18
- splat-transform [GLOBAL] <input.{ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|meta.json|csv}> [ACTIONS]
28
+ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|meta.json|csv}> [ACTIONS]
19
29
  ```
20
30
 
21
31
  **Key points:**
@@ -26,6 +36,7 @@ splat-transform [GLOBAL] <input.{ply|splat|ksplat}> [ACTIONS] ... <output.{pl
26
36
 
27
37
  **Input:**
28
38
  - `.ply` - Standard PLY format
39
+ - `.compressed.ply` - Compressed PLY format (auto-detected and decompressed on read)
29
40
  - `.splat` - Binary splat format (antimatter15 format)
30
41
  - `.ksplat` - Compressed binary splat format (mkkellogg format)
31
42
 
@@ -76,6 +87,10 @@ splat-transform input.ksplat output.ply
76
87
  # Convert to compressed PLY
77
88
  splat-transform input.ply output.compressed.ply
78
89
 
90
+ # Uncompress a compressed PLY back to standard PLY
91
+ # (compressed .ply is detected automatically on read)
92
+ splat-transform input.compressed.ply output.ply
93
+
79
94
  # Convert to SOGS format
80
95
  splat-transform input.ply output/meta.json
81
96
  ```