Setup and configuration

Toolkit Apps and Engines

Every pipeline is different, so we tried to not only make our Shotgun Pipeline Toolkit highly configurable, but also very modular. Each content creation application that the Shotgun Toolkit supports has an Engine that manages the Apps. You can find an overview of all integrations over at our support site.

Configuration and Setup

Setting up a Toolkit project is merely a starting point. Once you are up and running with our default setup, we suggest that you start tinkering and exploring our configuration system. Toolkit is highly modular and can be tailored to fit your specific pipeline needs.

Toolkit App development

Getting started

A Shotgun Toolkit project comes with a collection of default apps and integrations. But this is just the beginning. Toolkit is also a platform which makes pipeline tools development, deployment and reuse easy. You can build your own apps where you have specific needs. Writing your tool on top of Toolkit's libraries and frameworks means you can leverage an existing base and focus your time and effort on the specific business logic of your tool.

Toolkit Core API

The Toolkit Core API is the platform upon which all integrations and functionality are built. The Core API handles app, engine and platform fundamentals as well as file system and deploy management.

Shotgun Utilities Framework

A collection of Shotgun related Helpers and utilities make App development easier. This framework includes a Shotgun (MVC) Model which makes it easy to connect a Shotgun query with a standard QT View as well as classes for managing settings, background Shotgun processing and globals such as schema, statuses and icons.

Qt Widgets Framework

A large collection of Shotgun Related QT widgets make it easy to quickly build a nice looking front-end to your App. This framework includes multiple custom QT views, delegates and widgets.