Shotgun - Jump to the File System

Launch Folder

Jump from a Shotgun page to the file system.
By: Shotgun Software
Latest Version: v0.1.5 (beta)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-shotgun-launchfolder

Overview

This app makes it easy to jump from Shotgun into the file system. Just click a Shot, Asset or other entities and select the Show in File System option - Shotgun will launch a finder window on the mac, your preferred browser on Linux and explorer on Windows.

Documentation

The Launch Folder App is a Shotgun utility which allows you to jump from Shotgun into the File System.

How it works

The Launch Folder App allows you to jump from Shotgun into the File System. You can register it for Shotgun entity types such as Shots, Assets and Sequences. Once activated, it will appear on the Action menu:

Shotgun

You can select a single or multiple entries in Shotgun and when you click the menu action a standard file browser will be launched (Explorer on Windows, Finder on Mac etc.)

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to the Shotgun action menu for Assets in Project XYZ, execute the following command:

> tank Project XYZ install_app shotgun_asset tk-shotgun tk-shotgun-launchfolder

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 https://github.com/shotgunsoftware/tk-shotgun-launchfolder.

Special Requirements

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

Configuration

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.

deny_permissions

Type: list

Description: An optional parameter which lets you limit the visibility of this app. If you for example put in ['Artist'] as the value for this parameter, any user belonging to the shotgun permissions group Artist will not be able to see or execute the App.

deny_platforms

Type: list

Description: An optional parameter which lets you turn off this app on certain platforms. If you don't want it to appear on the Shotgun Pipeline Toolkit action menu for a platform, just include it in the the deny_platforms list. Valid values are Windows, Mac and Linux.

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!

v0.1.5

Renames and support for the new name Sgtk.

v0.1.4

Renames and support for the new name Sgtk.

v0.1.3

Adjustments for Tank Core v0.13

v0.1.2

Now uses new API methods for file system lookups.

v0.1.1

Updated manifest to require core v0.12.5

v0.1.0

First Release with the new Tank API.

v0.0.1

Initial release to the App Store.

Follow

0 Comments

Please sign in to leave a comment.