ftrack connect unreal engine

Welcome to ftrack connect unreal 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-unreal-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-unreal-engine/build/doc/html/index.html

Supported Platforms

  • Currently supported on Windows 10.
  • Compatible with ftrack-connect-package 1.1.0 - 1.1.2

Setup and Install

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

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

Building ftrack unreal project plugin

In case of a new version of Unreal Engine is released, and the plugin result incompatible, the plugin can be manually recopiled. The plugin sources are stored with the integration itself and available under the ‘resource/plugins’ folder.

Note

This process will require to have the windows development kit installed.

  1. Start Unreal engine with connect
  2. Create a c++ project
  3. Copy Plugin FTrackPlugin from ‘resource/plugins’ to your UE4 project plugins folder (i.e.: MyProject/Plugins)
  4. Restart the unreal through ftrack-connect. This will trigger the re compilation of the plugin for your current version.

Once compiled you can save the compiled package through the Unreal plugin window, using the same procedure used to Distribute the plugin to the Epic Marketplace.

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 unreal project

Note

Please review the Supported Platforms requirements before installing the packages.

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

Note

ftrack dialogs tend to show behind the Unnreal editor window.

Trubleshooting

Known issues and Limitations

  1. The ftrack plug-in for Unreal Engine is currently supported on Windows platforms.

publishing limitaions

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).

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

    Update hook for application launcher.

  • Fixed

    Animation import settings are set by file format.

  • changed

    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
  • Fix

    .plugin misses of various fields needed for the marketplace release.

  • New

    Add integration usage tracking.

1.0.0

2 September 2020
  • Changed

    Review documentation for plugin rebuild procedure.

1.0.0-RC2

4 May 2020
  • Fix

    Disable publish for unsupported asset types.

  • New

    Add sphinx documentation.

1.0.0-RC1

24 April 2020
  • New

    Ensure publish on any context.

  • New

    First stable release.

Indices and tables