Shotgun Engine for Mari Shotgun Integration in Mari By: Shotgun Software Latest Version: v1.1.5 (prod) For our version numbers, we follow the Semantic Versioning standard. System Name: tk-mari

Overview

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. The Shotgun engine for Mari provides a bridge between the Mari application and Shotgun through the Shotgun Pipeline Toolkit. The engine uses metadata in Mari to help track projects, geometry and geometry versions. Together with the loader, breakdown and publish Multi-apps, it helps integrate Mari seamlessly into the rest of your pipeline.

Supported Application Versions

This item has been tested and is known to be working on the following application versions: 2.6, 3.0. Please note that it is perfectly possible, even likely, that it will work with more recent releases, however it has not yet been formally tested with these versions.

Overview Video

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

Documentation

We're currently working on the docs for this engine but in the mean time, if you have any questions, please contact toolkitsupport@shotgunsoftware.com.

Installation and Updates

Adding this Engine to the Shotgun Pipeline Toolkit

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

> tank Project XYZ install_engine asset tk-mari

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

Special Requirements

• You need Shotgun Pipeline Toolkit Core API version v0.14.66 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.

debug_logging

Type: bool

Description: Controls whether debug messages should be emitted to the logger

compatibility_dialog_min_version

Type: int

Default Value: 2

Description: Specify the minimum Application major version that will prompt a warning if it isn't yet fully supported and tested with Toolkit. To disable the warning dialog for the version you are testing, it is recomended that you set this value to the current major version + 1.

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!

v1.1.5

2017-Aug-10

Ups maximum supported version to 3.3.

v1.1.4

2016-Feb-18

Adds a call to log a user metric for the DCC version

v1.1.3

Better handling of PythonQt import issues in Mari 2.x.

v1.1.2

Handles metadata requests in Mari 2.x properly.

Details:

When in an empty session of Mari 2.x, it's often the case that referencing the geo and project entity classes fails with an AttributeError. This is now handled appropriately during get_metadata calls.

v1.1.1

Better handles metadata requests and updated icon.

Details:

When requesting SGTK metadata from the engine, if there are no active projects in Mari an empty dictionary is returned. Previously this would have resulted in an unhandled AttributeError being raised.

v1.1.0

Adds support for Mari 3.0.

v1.0.2

Fixed issue where channel options were being ignored when loading geometry

v1.0.1

Minor improvements

Details:

• Added version check to warn if the engine is compatible with the version of Mari
• Updated code that finds publishes to compare name, type, entity rather than path

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!

v1.0.0

Initial release of the Mari engine

Details:

• Hosts Shotgun apps within Mari and integrates Mari with the rest of your Texture pipeline
• Exposes api methods on the engine object to easily create projects and import geometry and geometry versions in a Shotgun aware manner
• Provides the usual Shotgun context management, setting the Work Area automatically when switching between Shotgun aware Mari projects