Mari Project Manager

Shotgun aware project management for Mari
Latest Version: v1.2.1 (prod)
For our version numbers, we follow the Semantic Versioning standard.
System Name: tk-mari-projectmanager

Please Note: This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for more details.

Overview Summary
Documentation
Installation, Updates and Development
Configuration Options
Release Notes History

The Mari Project Manager streamlines the process of creating new projects in Mari, allowing artists to quickly select published geometry to load using the Shotgun Loader. Projects created with this app are Shotgun aware, helping artists publish textures to other parts of the pipeline without having to be concerned about export options and file locations.

Documentation

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

Loader

The Shotgun Loader lets you quickly overview and browse the files that you have published to Shotgun. A searchable tree view navigation system makes it easy to quickly get to the task, shot or asset that you are looking for and once there the loader shows a thumbnail based overview of all the publishes for that item. Through configurable hooks you can then easily reference or import a publish into your current scene.

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

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


                > tank Project XYZ install_app asset tk-mari tk-mari-projectmanager

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

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.

publish_types

Type: list

Default Value: [u'Alembic Cache']

Description: A list of publish types that can be opened as geometry into Mari. They will be used to filter the Select Publish dialog when adding geometry publishes to be loaded into a new project.

post_project_creation_hook

Type: hook

Default Value: {self}/post_project_creation.py

Description: Specify a hook that will run after the project was created in Mari.

get_project_creation_args_hook

Type: hook

Default Value: {self}/get_project_creation_args.py

Description: Specify a hook that will return the additional arguments that will be passed to the Mari project creation method. See default hook and Mari documentation for details of what these args should be.

template_new_project_name

Type: template

Description: A template used to construct the name for a new Mari project. This template must contain a 'name' key.

default_project_name

Type: str

Default Value: Shotgun

Description: The default name that gets used to populate the UI when starting a new project.

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

Fixes a crash bug in Mari 4.x on CentOS 6.

v1.2.0

Adds post_project_creation_hook.

v1.1.0

Added publish_types setting to be able to control the types of publishes that can be added to a new project

v1.0.0

Initial release of the Mari project manager app

Details:

Provides a UI to allow artists to easily create new projects in Mari that are Shotgun aware.
Using the loader UI, artists can easily choose one or more Published geometry files to include in the new project.

v0.0.4

Test release

Mari - Project Manager