@playcanvas/splat-transform 0.8.0 → 0.9.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
@@ -3,13 +3,16 @@
3
3
  [![NPM Version](https://img.shields.io/npm/v/@playcanvas/splat-transform.svg)](https://www.npmjs.com/package/@playcanvas/splat-transform)
4
4
  [![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/splat-transform)](https://npmtrends.com/@playcanvas/splat-transform)
5
5
  [![License](https://img.shields.io/npm/l/@playcanvas/splat-transform.svg)](https://github.com/playcanvas/splat-transform/blob/main/LICENSE)
6
+ [![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white&color=black)](https://discord.gg/RSaMRzg)
7
+ [![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white&color=black)](https://www.reddit.com/r/PlayCanvas)
8
+ [![X](https://img.shields.io/badge/X-000000?style=flat&logo=x&logoColor=white&color=black)](https://x.com/intent/follow?screen_name=playcanvas)
6
9
 
7
10
  | [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
11
 
9
12
  SplatTransform is an open source CLI tool for converting and editing Gaussian splats. It can:
10
13
 
11
14
  📥 Read PLY, Compressed PLY, SPLAT, KSPLAT formats
12
- 📤 Write PLY, Compressed PLY, CSV, and SOGS formats
15
+ 📤 Write PLY, Compressed PLY, CSV, SOG and HTML viewer formats
13
16
  🔗 Merge multiple splats
14
17
  🔄 Apply transformations to input splats
15
18
  🎛️ Filter out Gaussians or spherical harmonic bands
@@ -33,7 +36,7 @@ npm install -g @playcanvas/splat-transform
33
36
  ## Usage
34
37
 
35
38
  ```bash
36
- splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|meta.json|csv}> [ACTIONS]
39
+ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] ... <output.{ply|compressed.ply|sog|meta.json|csv|html}> [ACTIONS]
37
40
  ```
38
41
 
39
42
  **Key points:**
@@ -51,8 +54,10 @@ splat-transform [GLOBAL] <input.{ply|compressed.ply|splat|ksplat}> [ACTIONS] .
51
54
  **Output:**
52
55
  - `.ply` - Standard PLY format
53
56
  - `.compressed.ply` - Compressed PLY format
54
- - `meta.json` - SOGS format (JSON + WebP images)
57
+ - `.sog` - SOG bundled format
58
+ - `meta.json` - SOG unbundled format (JSON + WebP images)
55
59
  - `.csv` - Comma-separated values
60
+ - `.html` - Standalone HTML viewer app
56
61
 
57
62
  ## Actions
58
63
 
@@ -76,6 +81,8 @@ Actions can be repeated and applied in any order:
76
81
  -v, --version Show version and exit
77
82
  -g, --no-gpu Disable gpu when compressing spherical harmonics.
78
83
  -i, --iterations <number> Specify the number of iterations when compressing spherical harmonics. More iterations generally lead to better results. Default is 10.
84
+ -p, --cameraPos Specify the viewer starting position. Default is 2,2,-2.
85
+ -e, --cameraTarget Specify the viewer starting target. Default is 0,0,0.
79
86
  ```
80
87
 
81
88
  ## Examples
@@ -99,8 +106,14 @@ splat-transform input.ply output.compressed.ply
99
106
  # (compressed .ply is detected automatically on read)
100
107
  splat-transform input.compressed.ply output.ply
101
108
 
102
- # Convert to SOGS format
109
+ # Convert to SOG bundled format
110
+ splat-transform input.ply output.sog
111
+
112
+ # Convert to SOG unbundled format
103
113
  splat-transform input.ply output/meta.json
114
+
115
+ # Convert to HTML viewer with target and camera location
116
+ splat-transform -a 0,0,0 -e 0,0,10 input.ply output.html
104
117
  ```
105
118
 
106
119
  ### Transformations
@@ -136,7 +149,7 @@ splat-transform input.ply --filterBands 2 output.ply
136
149
  splat-transform -w cloudA.ply -r 0,90,0 cloudB.ply -s 2 merged.compressed.ply
137
150
 
138
151
  # Apply final transformations to combined result
139
- splat-transform input1.ply input2.ply output.ply -t 0,0,10 -s 0.5
152
+ splat-transform input1.ply input2.ply output.ply -p 0,0,10 -e 0.5
140
153
  ```
141
154
 
142
155
  ## Getting Help