Installation

1. Download the Custom Shelf (Beta) script
2. Unzip the downloaded zip file
3. In Cavalry navigate to Help > Show Scripts Folder
4. Open the Scripts folder
5. Drag the contents of the zip into the Scripts folder
6. In Cavalry navigate to Scripts > Custom Shelf (Beta)

Known Issues

• Editing a button after the Custom Shelf has been closed results in a crash
• The context menu shows up again after clicking away from the current context menu (bug reported to Cavalry)

Creating a Button

Right click in the Custom Shelf window (or on a button) and select New Button…. This will open the Edit Window.

Dropping a Layer, Asset, file or script file on the Custom Shelf also creates a new button in the current context. The correct button type is automatically set.

Editing a Button

Right click on a button and select Edit… to edit the button. This will open the Edit Window. Select any button in the grid on the left to change its details.

Insert a Spacer

Right click on a button, select Insert Spacer and choose a size to visually separate the button from the rest of the buttons. The Spacer will be inserted on the right.

Right click on a Spacer to change its size or to delete it.

Remove From Context

Right click on a button and select Remove From Context to remove the button from the current context. It will keep the button in the other contexts.

Delete a Button

Right click on a button and select Delete to remove it from completely. This cannot be undone!

Hide a Button

Right click a button and select Edit…. Toggle all the contexts off to hide the button.

Pin Context

Click the Pin icon button on the right to pin the current context.

Edit Window

On the left is the button grid. Click on a button to show its details on the right.

Contexts

Choose the selection contexts for which the button should show up.

From left to right:

• Default

  Shows up when nothing is selected

• Composition

  Shows up when a Composition is selected in the Assets window

• Asset

  Shows up when an Asset is selected in the Assets window

• Layer

  Shows up when any type of Layer is selected

• Attributes

  Shows up when any attributes are selected

• Keyframes

  Shows up when any keyframes are selected

• Shape Points

  Shows up when any Editable Shape Points are selected

Action

Choose which action the button should perform.

• Create Primitive

  Creates the chosen Primitive Shape. Choose a Primitive in the dropdown menu.

• Create Layer

  Creates the chosen Layer. Choose a Layer in the dropdown menu.

• Add Expression

  Adds an Attribute Expression to the selected Attribute. Click the expression icon button to load the Expression from the selected Attribute.

• Apply Easing

  Applies the chosen Easing to the selected Keyframes. Choose an Easing in the dropdown menu. Use the Magic toggle to apply a Magic Easing.

• Import Asset

  Imports the chosen asset. Choose an asset with the file selector.

• Run Script

  Runs the chosen script. Choose a script with the file selector.

Icon

The icon will be set automatically for the chosen action. Use the file selector to set a custom PNG icon for the button. The selector will default to the Cavalry icons folder.

The icon should ideally be 26 by 26 pixels and have a variant twice the size with the same filename and a @2x suffix.

Tooltip

The tooltip will be set automatically for the chosen action, but you can write down anything you want.

Backups Folder

Click the button to open the backups folder.

Every time you open the Edit Window it will create a backup. It will keep a maximum of 50 backups after which it will delete the oldest backup.

Test

Click this button to make sure the current settings perform the correct action.