🛠️ SkyCaster Rendering Client – Usage Guide

Render map configurations from your terminal with the skycaster command. The command writes an MP4 file; for live SDI or HDMI output through a DeckLink card, use the app window instead.

⚙️ Usage

skycaster --configs=<name:secs,...> --apiKey=<key> [options]
skycaster --config=<name> --apiKey=<key> [options]
skycaster update

Required

--apiKey — Your Skycaster API key
and one of:
- --configs — Comma-separated list of config:duration pairs, e.g. --configs=NYC-weather:30,RTS-flyover:60
- --config — A single config name (use with --duration)

Optional

Flag	Description	Default
`--duration`	Duration in seconds for single `--config` mode	`30`
`--fps`	Frames per second	`30`
`--res`	Resolution `WxH`	`1920x1080`
`--bitrate`	Video bitrate in kbps	`8000`
`--transition`	Transition between configs, in seconds	`5`
`--easing`	Transition easing: `linear` or `ease-in-out`	`linear`
`--output`	Output file path	`<Videos>/SkyCaster/output-<first config>.mp4`
`--local`	Load the config from a local JSON file instead of the API	off
`--no-gpu`	Use the CPU renderer instead of the GPU	off
`--angle`	GPU backend: `auto`, `vulkan`, `d3d11`, `d3d11-sw`, `metal`, `gl`	`auto` (Metal on Mac, Vulkan on Windows with automatic D3D11 fallback)
`--encoder`	H.264 encoder: `auto`, `libx264`, `h264_videotoolbox`, `h264_nvenc`, `h264_qsv`, `h264_amf`, `h264_mf`	`auto` (hardware if available)
`--reprobe-encoders`	Re-test which encoders work instead of reusing the saved result (after a GPU or driver change)	off
`--workers`	Parallel render processes; `1` disables parallelism	half the logical CPUs, at most 1 per GB of RAM above 4 GB, at most 8
`--frames`	Render only a slice: `<start>:<end>` frame numbers (end exclusive)	whole video
`--detail`	Map detail: `max`, `high`, `medium`, `low`	`high`
`--help`	Show all options

skycaster update installs the latest version.

🧠 Examples

Render two configs back-to-back (30 s + 60 s):

skycaster --configs=NYC-weather:30,ZUR-flyover:60 --apiKey=abc123

Single config at a higher frame rate:

skycaster --config=NYC-weather --apiKey=abc123 --duration=45 --fps=60

Custom resolution and output path:

skycaster --configs=A:20,B:20,C:20 --apiKey=abc123 --res=1920x1080 --output=out.mp4

Use a local JSON config file:

skycaster --config=my-config --apiKey=abc123 --local

🧩 Notes

Config names must match map configurations saved on the Live Maps page of your dashboard, unless --local is used.
With --local, the client reads <configName>.json from the current directory.
--apiKey is required in every mode, including --local, and the account needs an active subscription.
FFmpeg is bundled — no separate installation required.

🆘 Troubleshooting

Invalid API key / Access denied — check the key and that your subscription is active.
Rendering problems on virtual or headless machines — try --no-gpu, or another --angle backend.
After a GPU or driver change — run once with --reprobe-encoders.

📞 Need Help?

Docs: docs.skycaster.tv
Support: support@skycaster.tv