Docs & changelog

Getting started.

Full documentation ships with the partner beta. Here’s the shape of a first session, so you know what to have ready.

Getting started steps

  1. Before you installCheck your machineCompare your Mac or NVIDIA workstation against the hardware tiers. Plan where originals, proxies and engine weights will live.
  2. InstallRun the first-run doctorIt checks GPU, drivers, memory and free disk, benchmarks the machine and recommends Local, Hybrid or Cloud.
  3. SettingsConnect providers (optional)Add your own API keys — stored in the OS keychain. Download open-weights engines, accepting each publisher’s license.
  4. StorageRegister Media VolumesName your internal SSD, external drives and NAS shares, and set a placement policy.
  5. HomeStart a projectType a Spark, drop a document and choose “Adapt this”, or import footage. Pick a production type and Look Pack.
  6. BackupSet a backup targetAn external drive, NAS, synced folder or S3-compatible bucket. Backups are incremental and hash-verified.

Guides in progress

What the docs will cover.

  • Projects — folder anatomy, versions, Alternates and Save Points
  • Workspaces — a guide for each of the eleven, Develop to Deliver
  • Engines — providers, run locations, quality tiers and the Writing Check
  • Editing — shortcut presets for Resolve, Final Cut and Premiere
  • Delivery — presets, captions, loudness targets and labeling checks
  • Handoff — OpenTimelineIO, FCPXML and EDL round-trips
  • Storage — Media Volumes, relinking, backup and restore
  • Teams — roles, sync remotes, shared media stores and review
  • Templates — custom production types and Look Packs as files

Project anatomy

MyFilm.spx/
  project.yaml
  bible/       style bible, characters/, locations/, props/
  develop/     spark.md, logline.md, treatment.md, sources/
  script/      script.fountain, beats.yaml, breakdown/
  design/      moodboards/, concept/, look.yaml
  boards/      boards.yaml, frames/, animatic/
  shoot/       S010-sh020/shot.yaml, takes/T001.json
  edit/        timeline.otio, grades/, titles/
  sound/       dialogue/, sfx/, score/, mix.yaml
  deliver/     masters/, captions/, packages/
  .studio/     cache, proxies, job database
  .git/        history

Changelog

Release notes.

No public releases yet

Release notes will appear here with the first partner-beta build. Each entry will list new features, fixes, registry updates and any changes to supported hardware.

Want early access to the docs?

Beta partners get documentation, builds and a direct feedback channel.