The Command Line
Beside the studio, Methodox Splats installs a program called splats that does the same work without a window. It is in the folder the program was installed to. splats help lists every command and option; this page is the map.
From a video to a scene in one line
splats auto walk.mp4 --out walk
auto keeps the sharpest frames of the video, solves the cameras, trains, and writes the scene to walk/splat.ply, with a picture of the scene beside each photograph it kept back, to judge it by. A folder of photographs works in place of the video.
| Option | Does |
|---|---|
--frames <n> |
How many frames to keep from a video (200) |
--unordered |
The photographs are not in the order they were taken; see Filming for a scene |
--iterations <n> |
Training steps (7000) |
--max-splats <n> |
The splat budget (300000) |
--max-size <px> |
The longest side of the pictures trained from (1024) |
--format <ext> |
ply, spz, sog, glb, splat or blend |
One step at a time
| Command | Does |
|---|---|
splats gpu |
Says which graphics card the work would run on |
splats frames <video> --out <folder> |
Keeps the sharpest frames of a video |
splats cameras <photographs> --out <folder> |
Solves where each photograph was taken, as a COLMAP model |
splats train <capture> --out <folder> |
Trains a scene from a solved capture. --project also writes project.msplat for the studio |
splats animate <capture> --out <folder> |
Trains a scene that moves from a camera rig's capture |
splats track <video> --out <folder> |
Writes a camera track for Blender, with no training |
Working with a finished scene
| Command | Does |
|---|---|
splats info <file> |
What a scene file or a project holds |
splats convert <input> <output> |
Changes format; the format is taken from the file's ending |
splats edit <input> <output> |
Removes faint or oversized splats, crops, reduces to a count, turns, moves and resizes |
splats render <scene> --out <picture or video> |
Draws the scene to a PNG, or to an MP4 of a turn round it when the output ends in .mp4 |
splats score <scene> --capture <folder> |
Measures how closely a scene reproduces a capture's photographs |
splats convert walk/splat.ply walk.spz
splats edit walk.spz tidy.spz --prune-opacity 0.05 --decimate 150000
splats render tidy.spz --out turn.mp4 --size 1920x1080 --seconds 10
Models
splats place puts a 3D model into a project, as the studio's Objects section does; see Models and the sun.
splats place scene.msplat --object lantern.glb --view 12 --pixel 640,500 --size 0.8
splats place scene.msplat --sun 140,35 --sun-strength 0.6
splats render scene.msplat --view 12 --out shot.png
The first line stands the lantern where pixel 640, 500 of the project's twelfth camera shows, the second gives the scene a sun, and the third draws the result. --remove <name> and --clear take models out, and --relight reads the scene's light again for the models already there.
splats light draws what the scene looks like from a point, all the way round: the light a model standing there is lit by.
Good to know
- Every command runs on the graphics card when there is one.
- A command says what it wrote and where when it finishes, and explains in a sentence when it cannot go on.
- Paths with spaces need quotes, as anywhere on a command line.