You are viewing the documentation for Deformable v0.3.0, an older version. Read the latest, v0.9.0
Blender Plugin
Getting started with Blender
Install the Blender plugin and drop a breakable sphere onto a floor in ten steps.
On this page
The Blender plugin is the way to use the Tangerina Deformable engine in Blender. You turn meshes into deformable objects, pick a material, and press Play. Objects bend, dent, bounce and break, and Blender caches every frame.
This page installs the plugin and walks you through a first simulation: a brick sphere that falls onto a floor and breaks.
Requirements
- Blender 5.2 or later.
- macOS (Apple silicon), Linux x64 or Windows x64.
- No account and no internet for the Free license. A Standard license needs the internet to activate, then at least once every 14 days.
Install the plugin
- Download the plugin from tangerina.io/deformable, on the Blender
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. Save the
.zipfile. Do not unzip it. Each.zipfile works on its own system only, and Blender refuses one built for another system. The file is named for the version and the system, such asdeformable-blender-v0.1.0-macos-arm64.zip. - In Blender, open Edit > Preferences > Get Extensions > Install from Disk.
- Choose the
.zipfile. Blender installs the plugin and enables it. - The plugin runs under the Free license, with every feature and up to 2,500 tetrahedrons per scene. Its preferences show Free license: up to 2,500 tetrahedrons per scene — Buy license. If you already activated a Standard license in the Maya plugin or one of the SDKs on this device, they show Standard license instead.
To check the install, open the Object menu in the 3D Viewport. It now ends with a Deformable submenu.
You can also install the plugin from a terminal. Replace the file name with the path of the file you downloaded:
blender --command extension install-file -r user_default -e deformable-blender-v0.1.0-macos-arm64.zipThe Free license and the Standard license are on License and preferences.
Where the plugin lives
The plugin adds three things to Blender:
| Where | What |
|---|---|
| 3D Viewport > Object > Deformable | Actions that create, edit, simulate and bake deformable objects. This is where most work starts. |
| Properties > Modifiers > Add Modifier > Deformable | Ready-made node trees, as Geometry Nodes modifiers, with their settings on the modifier panel. |
| Geometry Node Editor > Add > Deformable | The 13 Deformable nodes, for building or changing a tree by hand. |
Each action builds a Geometry Nodes modifier on the object. You change its settings on the modifier panel in the Properties editor, like any other modifier. How the engine works explains the ideas, and How the plugin works the parts in Blender.
Your first simulation
The scene: a sphere 3 m above a floor. The sphere is made of brick, so it breaks when it lands.
Make the sphere
- Choose File > New > General. Select the cube, press X and choose Delete.
- Choose Add > Mesh > UV Sphere.
- Press N to open the Sidebar. On the Item tab, set Location Z to
3 m. - Choose Object > Deformable > Create Object with Autocage.
The sphere gets the modifier Deformable Object (Autocage). 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 status bar at the bottom of the window shows the running tools, such as Deformable: Tetrahedralize (Sphere) 0:42.
The scene also gets a new object, Deformable Scene. It holds the simulation settings, such as gravity. It shows a small gravity arrow in the viewport and nothing in renders.
- Choose Object > Deformable > Assign Material Preset > brick.
Make the floor
- Choose Add > Mesh > Plane. In the Adjust Last Operation panel at the bottom left, set Size to
20 m. - Choose Object > Deformable > Create Bare Object > From Non-Closed Polygon Mesh. In the Adjust Last Operation
panel, set Thickness to
0.2 mand Direction to Down. 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, asPlane_original. - Choose Object > Deformable > Use Tetrahedral Mesh as Surface Mesh. The orange goes, and the slab renders with the plane’s materials. The plane has none, so it shows Blender’s default grey.
- Choose Object > Deformable > Make Kinematic. A Kinematic object does not fall. It stays where it is, or follows its animation.
Play
- Go to the first frame: press Shift+Left Arrow.
- Press Space to play.
The sphere falls, hits the floor at about frame 17 and breaks. New faces appear on the cracks.
Blender caches each frame as it plays. Scrub the timeline back to replay the cache. To see the change of a setting, return to the first frame and play again.
Try a different material
- Press Esc to stop, and go to the first frame.
- Select the sphere and choose Object > Deformable > Assign Material Preset > rubber.
- Play again. The rubber sphere bounces about 1 m high and does not break.
Try glass too: it cracks more than brick.
Stay inside the Free license’s limit
Under the Free license, a Deformable Scene simulates up to 2,500 tetrahedrons. The sphere above uses 212, and the floor 6. Select an object to see its count and the scene’s total in the status bar, such as Deformable: Sphere: 212 tetrahedrons; scene total 218. A scene over the limit says so there.
Some settings make many tetrahedrons. For example, Create Primitive Object > Sphere makes about 650, three times as many as the sphere above. To use fewer, see Preparing meshes.
Next steps
- How the engine works: objects, the scene, the tools and the start frame.
- Materials: the ten material values and the 43 presets.
- Fracture and splinters: control how objects break.
- How the plugin works: the node trees, the modifiers and where each setting is.
- Creating and editing objects: every way to make a deformable object.
- Playback, caching and baking: cache, bake and render.
- Troubleshooting: what to check when something goes wrong.