(artist-toolkit)=
# Artist Toolkit

The Artist Toolkit is a collection of tools to assist with file handling in parallel with the various supported DCC's.
An ArtBnkr addon/plugin needs to be installed to work correctly. This can be done from the DCC Plugins tab. These are updated automatically via the mitosis updater.

## User Interface

Below we have a screenshot of the interface with various numbered elements. In this example we have the DCC Plugins Tab open.

1. Artist Toolkit Switch: to enter Toolkit mode.
2. Mitosis Client Switch: to return to Mitosis Client mode.
3. User Info: Name, location and IP.
4. Minimise Button: Makes mitosis as small as possible.
5. Sessions Tab: From here we can see the DCC sessions that are currently connected and use the tools such as import, export, save as etc.
6. DCC Plugins Tab: Install the artbnkr plugin for Supported DCCs and view info.
7. Log: View session logs.
8. DCC specific Info: We can see if the app is installed, some general information and the path to where the plugin/addon code is stored. *The blender path is highlighted showing the part of the path that needs to be added as a script directory if configured manually.*
9. Install Button: Clicking the jigsaw piece icon installs the addon to your DCC. It will use the version defined in the Mitosis Client Apps Tab.

![Artist Toolkit with DCC Plugins Tab open](images/ArtistToolkit-01.jpg)

---

## Sessions

The Sessions Tab is where we can see the actual toolkit tools.
You can have multiple sessions in multiple DCCs or instances of the same DCC.
These are managed here, you can switch sessions and close sessions via the list.
The screenshot below shows the UI in a Toolkit focused mode, available by clicking the button shown as item 7.

1. Current active Session.
2. Close session button (the x). This will also close the DCC app.
3. Open, but inactive sessions. Click to focus/activate.
4. Disconnect button: This will disconnect the session from the DCC without closing. Useful for troubleshooting in combination with the DCC addon (5).
```{todo}
On Mac Os the disconnect button closes the DCC.
```
5. DCC ArtBnkr Toolkit Addon interface: Clicking the AB Artist Toolkit button establishes a new session connection if not already existing.
6. Minimise to Icons: A minimal version of the interface, using icons rather than text for the various tools.
7. Toolkit Focused Mode: Hides non-toolkit controls and info.
8. Current 'product'.
9. Tool Buttons: Import, Utils and Publish are collections of tools, clicking, reveals the specific tools for each collection. 

![Artist Toolkit with DCC Plugins Tab open](images/Toolkit-Sessions-01.jpg)

---

## Common Tools across DCCs

A number of tools are the same irrespective of which DCC is used.

### Save
A quick save of current version. No further UI interaction. Automatically pushes to server as well as saving locally.

### Save As
Version up and add username to file name.

![Artist Toolkit Save As](images/SaveAs-01.jpg) 

### Load As 
Load a new file. Here artists can navigate to other products using a mini artbnkr browser with icons for products. Select the file and then click 'Select File' (9).

![Artist Toolkit Load As Browser](images/Toolkit-Load_AS-01.jpg)

1. Current active Session.
2. Selected Product, example shows 'Extra-Moni'.
3. Selected Task, example shows 'rig'.
4. Work or Publish.
5. Assets or Shots.
6. Status Filter.
7. User Filter.
8. Breadcrumbs for navigation.
9. Select File Button. First the artist selects the desired file then clicks this button to complete the operation.
10. Indicates whether file is on server or available locally.
11. Click the 'X' to close Load As Dialogue.

---

## Blender Tools
A collection of tools specific to Blender work flow. 
It is currently geared towards 3D modelling and animation, with tools for video editing, compositing and texture painting coming soon.

### Import

![Artist Toolkit Blender Import](images/Import-Blender-01.jpg)

#### Basic Import

#### SmartAsset Builder

#### Smart Texture Import

#### TurnTable Import

#### Rig Import

#### Import Layout

#### Import Audio
Used in animation shots to import audio.


### Utils

#### Load Template

Opens up an AB browser in the vfx/assets/tools/dcc-templates folder where templates for each task are stored.

(smart-naming)=
#### Smart Naming

This will prepare geometry so as to be pipeline friendly, generally used by the modelling department.  
It will rename selected geometry and create a basic material per object. 
The format is:
_sequential piece number_asset name_object name minus spaces or special characters.
e.g: 
- _001_Lobo_EyeBallL
- _002_Lobo_EyeBallR
- _003_Lobo_IrisL
- _004_Lobo_IrisR
- _005_Lobo_Body

It will attempt to guess the asset name, a dialogue will appear with the offered asset name which can be modified.

#### Prep Anim Export Geo
A utility for the animation department that allows for cleanly named alembic files to be exported for lighting, specifically for props and characters.

Requires correctly formatted rigs (those that are inside a collection whos name ends with '-ASSET' and contain a collection for the geometry that ends with '-GEOMETRY'),
and a published source alembic from the model department.

The tool will search the blender scene and list the found rigs.  The artist 


### Publish

#### Basic Export
Exports whatever is selected in the scene as either alembic, usd or fbx. 
```{todo}
Currently not working - Was using the built in Blender file browser, but would be better to use the AB browser so as to upload to server on export.  Maybe superflous to needs as the model publish geo fulfills the same function.
```

#### Playblasta
This will create a playblast from the 3D viewport, prioritising the view that is looking through a camera. Whatever is seen in the viewport is what will be saved, plus a burn-in with relevant information. 

It will save an .mp4 to a folder named 'images' inside the current task inside 'Publish', as well as a .jpeg sequence in a folder called current-'the task', which will be overwritten each time. 

For example an animation playblast, the image sequence will be saved to Publish/anim/images/current-anim. 
On the ArtBnkr web app these can be viewed in the player. It will recognise an image sequence, and provide an entry which can be clicked to view.

#### Model Publish Geo

For Model Geometry Export.


#### Publish Layout

To be used with a master layout scene. Generally in Sets/Layout

Outputs:
CurrentLayout .blend: The one used by the import layout tool 
blender .blend a versioned shot specific .blend file with stuff
alembic
usd
fbx

In the case of Layouts that have animated assets, because of multi-level linking issues the layouts can include an action for the animated asset which can be imported the same way as any other rig be it character, vehicle or prop.

Blender Action naming convention for animated Layout Assets. To use with the Publish Layout Tool


{ASSETNAME}.LAYOUT.ACTION.{SHOTNAME}

e.g. 002-TRAIN.LAYOUT.ACTION.mt-5000

####

---

## Gaffer Tools