ftrack connect unity engine

Welcome to ftrack connect unity engine documentation. Please ensure you read through before installing it.

Note

User documentation can be found at help.ftrack.com

Build integration and documentation

Build Integration

You can also build manually from the source for more control. First obtain a copy of the source by either downloading the zipball or cloning the public repository:

git clone git@bitbucket.org:ftrack/ftrack-connect-unity-engine.git

Then you can build and install the package into your current Python site-packages folder:

python setup.py build_plugin

Building documentation

To build the documentation from source:

python setup.py build_sphinx

Then view in your browser:

file:///path/to/ftrack-connect-unity-engine/build/doc/html/index.html

Setup and Install

In here you’ll be able to find the documentation on how to install the integration.

Prerequisites

Python

Install Python 2.7.15 (64 bits) or later.

Warning

The package does not work with Python 3.

Once python is installed, from a cmd prompt, type python and make sure the installed Python can be discovered. If not, adjust your %PATH% environment variable to include the path where Python.exe resides.

In the Python interpreter, type the following code and make sure the returned value matches the directory where you installed Python:

>>> import sys
>>> print sys.executable

Quit the interpreter by typing

>>> quit()

Git

In order for Unity to pull packages from remote git repositories, the git application should be available. Please refer to your operating system application store to locate and install it.

install integration

Whether you have been downloading the integration or built yourself, copy the uncompressed folder in the %FTRACK_CONNECT_PLUGIN_PATH%

You can find more information on how to locate it in the ftrack help page

known limitations

publishing

Due to the limitation of the the current system, publishers for other assets types (eg: geometry, rig etc…) will be shown on asset level, but won’t be working.

Is Currently possible to publish only image_sequence asset (see documentation for details) on shot level.

Setting up the unity project

Note

Please review the Setup and Install requirements before installing the packages.

ftrack package

The ftrack package is accessible from a Git URL:

In the Package Manager window, locate the + sign, click on it, then select Add package from git URL…

Enter the following URL:

https://bitbucket.org/ftrack/ftrack-connect-unity-plugin.git`

ftrack should initialize and a menu named ftrack should be available in Unity

Note

ftrack dialogs tend to show behind the Unity editor window.

Trubleshooting

Known issues and Limitations

• The ftrack plug-in for Unity is currently supported on Windows platforms.

Locating Unity installations

If selecting a task does not make the Unity logo appear, you can try to set the %UNITY_LOCATION% environment variable to point to a valid Unity.exe editor. Otherwise the following notes from the Unity hook should help you make sure your editors can be discovered:

If %UNITY_LOCATION% is specified in the environment, it will be the only listed editor. Otherwise we discover Unity installations using these locations:

Note

The registry %HKEY_CURRENT_USER%SoftwareUnity TechnologiesInstaller.

This includes all the versions of Unity that were installed using the Hub

Note

%APPDATA%UnityHubeditors.json

This includes all the installations that were added using the “Locate a version” option in the Unity Hub

Note

%APPDATA%UnityHubsecondaryInstallPath.json

This provides a root path where multiple versions of Unity might exist

We use %APPDATA%UnityHubdefaultEditor.json to determine the default editor. If we find the default editor we make it the first item of the list.

Sporadic 30 seconds lag

There is a known, sporadic issue with the Python for Unity package where there might be a 30 seconds delay between the time an operation is launched and when it is actually processed. This can happen, for example, when accessing the ftrack menu items. The desired dialog might take 30 seconds before being displayed when the issue arises.

Unity 2019 and higher

When launching Unity 2019 and higher from ftrack-connect, the Unity Hub will appear. There is a limitation with the Unity Hub 2.0 which prevents ftrack from initializing properly. You need to stop all running Unity Hub.exe processes before launching Unity from ftrack-connect. This will be fixed by the Unity team in an upcoming release (tentative for Unity Hub 2.1)

Package Manager is not available in Unity

If you cannot see the Package Manager menu item, make sure you installed Microsoft Visual Studio Community Installing .NET Core prerequisites might help resolve this problem.

SSL Errors

If an SSL error is present during the run of the plugin please ensure OpenSSL for windows is installed and the full path to the libraries

• libeay32.dll
• sleay32.dll

are added in the %PATH%

Can publish only image sequence

The current integration allows to publish only image_sequence asset types. Due to technical limitations we are not able at the moment to disable the publish for the other asset types, but we are actively looking into a solution.

Result Image Sequence frames are vertically flipped

In case the image sequence is vertically flipped, change the recording settings for Capture to TargetCamera and set Flip Vertical.

Release and migration notes

Find out information about what has changed between versions and any important migration notes to be aware of when switching to a new version.

Release Notes

1.1.0

8 September 2021

• Changed

  Ported to connect2.

• Changed

  Update hook for application launcher.

• change

  SetupProvide dependency to ftrack-connector-legacy module.

Warning

From this version the support for ftrack-connect 1.X is dropped, and only ftrack-conenct 2.0 will be supported up to the integration EOL.

1.0.1

10 September 2020

• new

  Add integration usage tracking.

1.0.0

2 September 2020

• new

  Ensure compatibility with 2020 version.

1.0.0-RC2

4 May 2020

• Fix

  Disable publish for unsupported asset types.

• New

  Improve trubleshooting docs.

• New

  Improve logging.

1.0.0-RC1

24 April 2020

• New

  Ensure publish on any context.

• New

  First stable release.

Indices and tables

• Index
• Module Index
• Search Page