Introduction

Kitsu is a great open source production tracker and can be used for project management instead of Ftrack. This documentation assumes that you are familiar with Kitsu and its basic principles. If you're new to Kitsu, we recommend having a thorough look at Kitsu Official Documentation.

Kitsu Addon Installation​

If you have already connected your ayon instance to Ynput cloud, you would be able to get the addon from Addon Market.

Preparation for Kitsu Addon​

TL;DR

1. Ensure you have kitsu addon in your production bundle.

2. Add Kitsu Admin Account to AYON Secrets.

3. Configure Kitsu addon settings

4. Spawn Kitsu service.

Ensure kitsu addon in your production bundle​

You may create a new bundle that includes Kitsu Addon and set it to production if you don’t habe that already.

Add Kitsu Admin Account to AYON Secrets​

You’d need to add a kitsu account admin to secrets tab on AYON server.
You are free to name it what you want. For sake of clairty in this doc page, we will call them

• kitsu_email

• kitsu_password

Configure Kitsu addon settings

Then in Kitsu addon settings set:

• Kitsu Server

• Kitsu user email

• Kitsu user password

Spawn Kitsu service​

From Services, Create New Service.

Synchronize​

Synchronization is two step process. From Kitsu Tab:

1. Click Pair project

2. Click Sync now

Currently, Synchronization is one-way only Kitsu ➜ AYON.

Kitsu Productions	Kitsu Tab

Kitsu Addon Settings

Integrate Kitsu Note​

Task status can be automatically set during publish thanks to Integrate Kitsu Note. This feature can be configured in:

• ayon+settings://kitsu/publish/IntegrateKitsuNote.

Available settings:

• Set status on note: Turns on and off this integrator.

• Note shortname: Which status shortname should be set automatically (Case sensitive).

• Status change conditions: Conditions that need to be met for kitsu status to be changed. You can add as many conditions as you like.

  • Status Conditions: There are two fields to each conditions:

    • Condition (Whether current status should be equal or not equal to the condition status)

    • Short name (Kitsu Shortname of the condition status).

  • Product type requirements

    • Condition (Whether published product type should be equal or not equal to the condition status)

    • Product type (AYON Product type)

• Custom Comment Template -> when enabled, AYON publisher will use this template as Kitsu comment. You can use markdown as it's supported by Kitsu.

Custom Comment Template example​

Here's an example template that makes a nice table.

| comment | version | product type | name |
|--|--|--|--|
| {comment} | {version} | {productType} | {name}

Custom Comment Template

Artists need only to provide comment in publisher UI. And, Integrate Kitsu Note will do the hard work for them.

Sync Settings​

• Delete Projects: Enabling 'Delete projects' will remove projects on Ayon when they get deleted on Kitsu

• Sync users Sync Kitsu Users, their passwords and map Kitsu roles to AYON roles.

• Default sync info

  • Tasks (Name, Short Name, Icon)

  • Statuses (Short Name, State, Icon)

Q&A​

Is it safe to rename an entity from Kitsu?​

Absolutely! Entities are linked by their unique IDs between the two databases.

• If you rename an entity in the AYON project editor, this change won't show up in Kitsu. Instead, it will be replaced with the original name when the next sync happens.

• When you rename an entity directly in Kitsu, the new name will be updated in AYON during the upcoming synchronization.

Managing Multiple Production Tracker for Various Projects​

To effectively manage multiple projects with different production tracker addons such as ShotGrid and Kitsu, you'll need to include both addons in your production bundle. It will allow their respective tabs to appear within the Ayon server interface.

Then, you should activate or deactivate each addon based on the specific needs of the project at hand. You can usually do this within the project settings.