@playcanvas/splat-transform 0.7.0 → 0.8.1

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
@@ -9,7 +9,7 @@
9
9
  SplatTransform is an open source CLI tool for converting and editing Gaussian splats. It can:
10
10
 
11
11
  📥 Read PLY, Compressed PLY, SPLAT, KSPLAT formats
12
- 📤 Write PLY, Compressed PLY, CSV, and SOGS formats
12
+ 📤 Write PLY, Compressed PLY, CSV, and SOG formats
13
13
  🔗 Merge multiple splats
14
14
  🔄 Apply transformations to input splats
15
15
  🎛️ Filter out Gaussians or spherical harmonic bands
@@ -22,10 +22,18 @@ Install or update to the latest version:
22
22
  npm install -g @playcanvas/splat-transform
23
23
  ```
24
24
 
25
+ > [!IMPORTANT]
26
+ > **Windows Users:** You must have the debug version of the Microsoft Visual C++ runtime installed. This is because splat-transform currently depends on [Dawn](https://dawn.googlesource.com/dawn) which is built against the debug VC runtime. We have logged an [issue](https://issues.chromium.org/issues/443906265) against the Dawn project.
27
+ >
28
+ > In the meantime, to work around this problem, you need to install the debug VC runtime as follows:
29
+ >
30
+ > 1. Install [Visual Studio 2022 Community](https://visualstudio.microsoft.com/vs/community/)
31
+ > 2. In the installer, select "Desktop development with C++"
32
+
25
33
  ## Usage
26
34
 
27
35
  ```bash
28
- splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|meta.json|csv}> [ACTIONS]
36
+ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|sog|meta.json|csv}> [ACTIONS]
29
37
  ```
30
38
 
31
39
  **Key points:**
@@ -43,7 +51,8 @@ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] .
43
51
  **Output:**
44
52
  - `.ply` - Standard PLY format
45
53
  - `.compressed.ply` - Compressed PLY format
46
- - `meta.json` - SOGS format (JSON + WebP images)
54
+ - `.sog` - SOG bundled format
55
+ - `meta.json` - SOG unbundled format (JSON + WebP images)
47
56
  - `.csv` - Comma-separated values
48
57
 
49
58
  ## Actions
@@ -91,7 +100,10 @@ splat-transform input.ply output.compressed.ply
91
100
  # (compressed .ply is detected automatically on read)
92
101
  splat-transform input.compressed.ply output.ply
93
102
 
94
- # Convert to SOGS format
103
+ # Convert to SOG bundled format
104
+ splat-transform input.ply output.sog
105
+
106
+ # Convert to SOG unbundled format
95
107
  splat-transform input.ply output/meta.json
96
108
  ```
97
109