﻿---
title: Getting started with Maya
description: Install the Maya plugin as a module, load it in the Plug-in Manager, and drop a breakable sphere onto a floor.
url: https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/getting-started/
---

# Getting started with Maya – Maya Plugin – Deformable v0.7.0

The Maya plugin is the way to use the Tangerina Deformable engine in Maya. You turn meshes into deformable objects,
pick a material, and press Play. Objects bend, dent, bounce and break, and the plugin keeps every frame it simulates.

This page installs the plugin and walks you through a first simulation: a brick sphere that falls onto a floor and
breaks.

## Requirements

- Maya 2027.
- macOS on an Apple silicon Mac, Linux x64 or Windows x64.
- No account and no internet for Free. A Standalone subscription needs the internet to sign in, then at least once a
  day. A Standalone license needs the internet to activate, then at least once every 7 days.

### Apple silicon Macs only

On a Mac, the plugin runs on Apple silicon only, in Maya running natively. Maya started through Rosetta cannot load
it: the Plug-in Manager and the Script Editor show Maya's error that the plugin failed to load, and no Deformable menus
appear. To check, select **Maya** in the Finder's **Applications > Autodesk > maya2027** folder, choose **File > Get
Info**, and make sure **Open using Rosetta** is off.

## Install the plugin

The plugin is a Maya module: a file, `deformable.mod`, and a folder, `deformable`, that sit side by side in one of
Maya's modules folders.

1. Download the plugin from [tangerina.io/deformable](https://tangerina.io/deformable#download-maya), on the **Maya plugin**
   tab. Click **Download for** your system: the page detects it. To get another system's file (macOS Apple silicon,
   Linux x64 or Windows x64), pick it under **Other platforms**. The file is named for the version and the system, such
   as `deformable-maya-v0.1.0-macos-arm64.zip`. Each `.zip` file works on its own system only.
2. Quit Maya.
3. Unzip the file, and move `deformable.mod` and the `deformable` folder into your Maya modules folder. Make the folder
   if it does not exist:

   | System | Modules folder |
   |---|---|
   | macOS | `~/Library/Preferences/Autodesk/maya/modules` |
   | Linux | `~/maya/modules` |
   | Windows | `Documents\maya\modules` |

   On a Mac, the Finder hides `Library`: choose **Go > Go to Folder** and type the path.
4. On a Mac, clear the mark the browser put on the download, or macOS refuses to load the plugin. In the Terminal:

   ```sh
   xattr -dr com.apple.quarantine ~/Library/Preferences/Autodesk/maya/modules/deformable
   ```

5. Start Maya and [load the plugin](#load-the-plugin).

From a terminal, these commands do steps 3 and 4 on a Mac. Replace the file name with the path of the file you
downloaded:

```sh
mkdir -p ~/Library/Preferences/Autodesk/maya/modules
unzip deformable-maya-v0.1.0-macos-arm64.zip -d ~/Library/Preferences/Autodesk/maya/modules
xattr -dr com.apple.quarantine ~/Library/Preferences/Autodesk/maya/modules/deformable
```

To install a new version, or to remove the plugin, see
[Update the plugin](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/license-and-preferences/#update-the-plugin).

### Load the plugin

Load the plugin once, and tell Maya to load it every time it starts:

1. Choose **Windows > Settings/Preferences > Plug-in Manager**.
2. Find the plugin in the list. It is under the module's `plug-ins` folder, such as
   `.../maya/modules/deformable/plug-ins`, and named `deformable.bundle` on macOS, `deformable.so` on Linux and
   `deformable.mll` on Windows.
3. Turn on **Loaded**. Maya loads the plugin and builds its menus and its shelf.
4. Turn on **Auto load**, so Maya loads it when it starts.
5. Close the Plug-in Manager.

![The Plug-in Manager's row for deformable.bundle, under the module's plug-ins folder, with Loaded and Auto load both turned on.](../../images/maya-plug-in-manager.svg "Turn on Auto load in the Plug-in Manager, so Maya loads the plugin every time it starts.")

A scene file that holds Deformable nodes asks for the plugin when it opens, so Maya loads it then even without Auto
load. Turn Auto load on anyway, so the menus and the shelf are there before you open a file.

The plugin runs as Free, with every feature and up to 2,500 tetrahedrons per scene. Choose **Deformable Help >
License…** to see **Free: up to 2,500 tetrahedrons per scene**. If you already signed in with a
Standalone subscription or activated a Standalone license in the Blender plugin or one of the SDKs on this device, it
shows **Standalone subscription** or **Standalone license** instead. Free, the Standalone subscription and the
Standalone license are on
[License and preferences](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/license-and-preferences/).

## Where the plugin lives

The **Deformable** shelf comes after Maya's own shelves and is one of the main ways to use the plugin.

![The Deformable shelf's buttons on one row, in seven groups: creating objects, surface meshes and splinters, editing objects, the material node, regions, checking meshes, and simulating, baking and extracting output shapes. A small triangle marks each button that lists its variants on a right-click.](../../images/maya-deformable-shelf.svg "Hover a button to see its name, and right-click a button with a small triangle to pick a variant.")

The plugin adds these to Maya:

| Where | What |
|---|---|
| The **Deformable** menu set | Five menus: **Deformable Object**, **Edit Deformable**, **Deformable Material**, **Deformable Scene** and **Deformable Help**. Pick the menu set in the menu set list at the left end of the Status Line, where **Modeling** and **Rigging** are. |
| The **Deformable** shelf | A button for the actions you use most, from **Create Scene** to **Extract Output Shapes**. Hover a button to see its name. |
| The Attribute Editor | The settings of each Deformable node, on the tabs of the object you select. |
| Ten node types | `deformableScene`, `deformableObject`, `deformableMaterial` and seven tool nodes: `deformableTriangulate`, `deformableTetrahedralize`, `deformableExtrude`, `deformableSpanLayers`, `deformableAutocage`, `deformablePrepare` and `deformableSplinter`. The actions make and connect them for you. |

This guide names keys as Maya does on Windows and Linux. On a Mac, press **Option** for **Alt**; **Ctrl** is the
**Control** key, and **Command+Z** undoes too.

Every menu item is also a runtime command in the **Hotkey Editor**, under **Menu items > Deformable**, so you can
give it a hotkey; so is every option box, named after its item with **Options** at the end. A menu item with an option box (![Option box](https://help.tangerina.io/deformable/v0.7.0/images/option-box.svg)) opens a window of its options. On the shelf, double-click such a
button to open the same window. A few buttons list their variants when you right-click them, such as the five sources
of **Create Bare Object**.

Each action builds Maya nodes in the object's history. You change their settings in the Attribute Editor and the Channel
Box, like any other node. [How the engine works](https://help.tangerina.io/deformable/v0.7.0/user-guides/engine/how-the-engine-works/) explains the
ideas, and [How the plugin works](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/how-the-plugin-works/) the parts in Maya.

## Your first simulation

The scene: a sphere 3 units above a floor. The simulation reads one Maya unit as one metre, so this sphere is 2 m
wide. It is made of brick, so it breaks when it lands.

![A sphere 3 m above a thin floor slab.](../../images/getting-started-first-scene.svg "The simulation reads one Maya unit as one metre, so the sphere starts 3 m above the floor.")

### Make the sphere

1. Choose **File > New Scene**.
2. Choose **Create > Polygon Primitives > Sphere**. In the Channel Box, set **Translate Y** to `3`.
3. Pick the **Deformable** menu set, and choose **Deformable Object > Create Object with Autocage**, or click
   
   **Create Object with Autocage** on the shelf.

The plugin wraps the sphere in a light cage, fills the cage with tetrahedrons, and keeps your sphere as the render
surface. While it computes, the progress bar at the bottom of Maya's window shows the running tools, such as
**Deformable: Tetrahedralize (pSphere1) 0:42**. Once they finish, the Script Editor and the Command Line say
**Deformable: Created pSphere1: 192 tetrahedrons; scene total 192**.

The scene also gets a new node, **deformableScene1**. It holds the simulation settings, such as gravity. It draws a
small gravity arrow in the viewport and nothing in renders.

4. Choose **Deformable Material > Assign Material Preset > brick**.

### Make the floor

5. Choose **Create > Polygon Primitives > Plane**. In the Channel Box, under **INPUTS**, click **polyPlane1** and set
   **Width** and **Height** to `20`, and **Subdivisions Width** and **Subdivisions Height** to `1`.
6. Choose the option box (![Option box](https://help.tangerina.io/deformable/v0.7.0/images/option-box.svg)) of **Deformable Object > Create Bare Object > From Non-Closed Polygon Mesh**. Set **Thickness**
   to `0.2` and **Direction** to **Down**, and click **Create**. The plane becomes a slab of
   tetrahedrons below its surface, drawn in see-through orange, the color of a bare object. Your plane is kept,
   hidden, as the object's original shape.
7. Choose **Deformable Object > Use Tetrahedral Mesh as Surface Mesh**. The orange goes, and the slab renders with the
   plane's shading, Maya's default grey.
8. Choose **Edit Deformable > Make Kinematic**. A Kinematic object does not fall. It stays where it is, or follows its
   animation.

### Play

9. Go to the first frame: click **Go to start of playback range** at the left of the playback controls, or press
   **Alt+Shift+V** (**Option+Shift+V** on a Mac).
10. Click **Play forwards**, or press **Alt+V** (**Option+V** on a Mac).

The sphere falls, hits the floor at about frame 17 and breaks into about 28 pieces. New faces appear on the cracks.

The plugin keeps each frame it simulates. Scrub the Time Slider back to watch it again. To see the change of a
setting, return to the first frame and play again.

**Create Object with Autocage** set the playback to **Play every frame**, because a frame that playback skips is never
simulated. Keep it that way: see [Play](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/playback-and-baking/#play).

### Try a different material

1. Press **Esc** to stop, and go to the first frame.
2. Select the sphere and choose **Deformable Material > Assign Material Preset > rubber**.
3. Play again. The rubber sphere bounces about 1 m high and stays in one piece.

Try **glass** too: it breaks into more pieces than brick.

![The brick sphere lies broken in pieces on the floor, and the rubber sphere bounces about 1 m high.](../../images/getting-started-brick-and-rubber.svg "Only the material differs: the brick sphere breaks when it lands, and the rubber one bounces.")

## Stay inside the limit of Free

On Free, a Deformable Scene simulates up to 2,500 tetrahedrons. The sphere above uses 192, and the
floor 6. Each create action names its object with its count and the scene's total, such as
**Deformable: Created pPlane1: 6 tetrahedrons; scene total 198**. A scene over the limit says so then. See
[Count the tetrahedrons](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/how-the-plugin-works/#count-the-tetrahedrons).

Some settings make many tetrahedrons. For example, **Create Primitive Object > Sphere** makes 836, four times as many
as the sphere above. To use fewer, see [Preparing meshes](https://help.tangerina.io/deformable/v0.7.0/user-guides/engine/preparing-meshes/).

## Next steps

- [How the engine works](https://help.tangerina.io/deformable/v0.7.0/user-guides/engine/how-the-engine-works/): objects, the scene, the tools and the
  start frame.
- [Materials](https://help.tangerina.io/deformable/v0.7.0/user-guides/engine/materials/): the ten material values and the 43 presets.
- [Fracture and splinters](https://help.tangerina.io/deformable/v0.7.0/user-guides/engine/fracture-and-splinters/): control how objects break.
- [How the plugin works](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/how-the-plugin-works/): the nodes, the shapes and where each
  setting is.
- [Creating and editing objects](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/creating-objects/): every way to make a deformable
  object.
- [Playback, caching and baking](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/playback-and-baking/): play, bake and render.
- [Troubleshooting](https://help.tangerina.io/deformable/v0.7.0/user-guides/maya/troubleshooting/): what to check when something goes wrong.
