Perforce – General Functionality


This app provides common Perforce commands such as check-out and revert of the current scene, directly from the Shotgun menu. Additionally, it also handles Perforce login on start-up and provides a command to help manage any pending publishes that are yet to be submitted to Perforce

By: Shotgun Software
Latest Version: v0.1.2 (alpha)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-multi-perforce


This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for details. This app provides common Perforce functionality across the different applications allowing artists to work with Perforce in the same way if they are in Maya, Photoshop, etc

Overview Video

The following video gives a quick overview of features and functionality.


We're currently working on the docs for this app but in the mean time, for a more high-level overview of how we've integrated Perforce into Shotgun Pipeline Toolkit, please see this page:

Related Apps and Documents

Perforce Integration

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the [Shotgun Integrations Admin Guide]( for details. This document describes the Perforce integration for Toolkit - what it is, who it is aimed at and a high level overview of how it is implemented.

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to Project XYZ, in an environment named asset, execute the following command:

> tank Project XYZ install_app asset tk-maya tk-multi-perforce

Updating to the latest version

If you already have this item installed in a project and you want to get the latest version, you can run the update command. You can either navigate to the tank command that comes with that specific project, and run it there:

> cd /my_tank_configs/project_xyz
> ./tank updates

Alternatively, you can run your studio tank command and specify the project name to tell it which project to run the update check for:

> tank Project XYZ updates

Collaboration and Evolution

If you have access to the Shotgun Pipeline Toolkit, you also have access to the source code for all apps, engines and frameworks in Github where we store and manage them. Feel free to evolve these items; use them as a base for further independent development, make changes (and submit pull requests back to us!) or simply tinker with them to see how they have been built and how the toolkit works. You can access this code repository at

Special Requirements

  • You need Shotgun Pipeline Toolkit Core API version v0.14.43 or higher to use this.


Below is a summary of all the configuration settings used. These settings need to be defined in the environment file where you want to enable this App or Engine.


Type: hook

Default Value: scene_operation_{engine_name}

Description: All the application specific scene operations (open, save etc) that the app needs to carry out are collected in this hook.


Type: bool

Default Value: True

Description: If set to True then the app will establish a connection at start-up and present the connection/password dialog to the uesr if needed.

Release Notes

Welcome to the release notes for this App. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!


Minor fix to error handling


Updated documentation


Restructured app code and updated to use new framework version syntax


Updated to use the latest version of the Perforce framework


Updated to require the latest version of the framework


Updated to use the latest version of the framework and core


Updated to require latest version of the Perforce framework


Updated to require Perforce framework v0.0.5


Updated to use latest version of the framework


Updated to require latest version of Perforce framework


Initial working version of the app