Skip to content

Project Configuration

Creating a new project bundle

  1. Create a directory under configs/: configs/<project-name>/
  2. Copy configs/defaults/kpipe.toml as a starting point
  3. Adjust the [anatomy] section for your file naming convention
  4. Add kpipe-kitsu.toml with the Kitsu server URL and credentials
  5. Add kpipe-publish.toml with the publishing pipelines for your product types

Anatomy (file naming)

The [anatomy] section defines path templates for workfiles and published products. Optional path segments are wrapped in </{segment}>.

[anatomy]
workfile = "{project}-{sequence}_{shot}-{task}-v{version}.{ext}"
product  = "{project}-{sequence}_{shot}-{product_type}-v{version}.{ext}"

DCC paths

Specify the executable path for each DCC:

[dcc.blender]
path = "C:/Program Files/Blender Foundation/Blender 5.0/blender.exe"

[dcc.nuke]
path = "C:/Program Files/Nuke15.0/Nuke15.0.exe"

Kitsu backend

# kpipe-kitsu.toml
[kitsu]
host = "https://kitsu.example.com"

Artists set their own login credentials under their [team.<username>] section.

Loading and Publishing pipeline

See Action Pipeline for how kpipe-publish.toml and kpipe-load.toml is structured.