Gaffer integration

Hi, I saw at some point that there was a Gaffer integration semi-implemented, am I right? if so, what can I do to use it?

There is currently a draft pull request on Github for the Gaffer Integration.

If you want to try this out the easiest way is pull in that branch and run from the source code. It depends on your expertise with Git and the OpenPype tools how easy that is for you. There are no ready to use builds/releases so you will have to start from the source code using the branch.

Running an OpenPype pull request branch from source code

A decent starting guide to build and run OpenPype from source is the dev build introduction documentation.

Here’s a quick overview of roughly the relevant steps with additional linked documentation to do so:

Quick start snippets for Windows

Here’s an example snippet .bat I use on Windows to quickly start from a freshly cloned repository:

set PATH=C:\Users\Roy\AppData\Local\Programs\Python\Python39;%PATH%
set PATH=C:\Program Files\Git\bin;%PATH%
cd /d S:\openpype\OpenPype

Depending on how strict your powershell execution policy is set and with some extra “comments” to explain things:

:: Set the path to your OpenPype git directory
set OPENPYPE_SOURCE_ROOT=S:\openpype\OpenPype
:: Ensure Python 3.9 is available
set PATH=%LOCALAPPDATA%\Programs\Python\Python39;%PATH%
:: Ensure Git executable is available
set PATH=C:\Program Files\Git\bin;%PATH%

PowerShell.exe -ExecutionPolicy Bypass -File .\tools\create_env.ps1
PowerShell.exe -ExecutionPolicy Bypass -File .\tools\fetch_thirdparty_libs.ps1
PowerShell.exe -ExecutionPolicy Bypass -File .\tools\run_tray.ps1

These are commands you should be able to run in Windows Command Prompt (cmd.exe) or you could save it in a .bat file to easily run it using cmd.exe.

Once you are succesfully “running tray” you should see the OpenPype tray as usual but now running from source. Good job! :medal_sports:

Enabling the gaffer application on you project.

Once you’ve launched OpenPype tray from source using that Gaffer Integration branch you should be able to start launching Gaffer. However, please keep in mind that you’ll need to set up the Gaffer executable paths and enable it for the current project. I’ve recently written a brief guide about why you might not see an application (like Gaffer) in the launcher yet and how to enable it.

Thank you so much @BigRoy