Figaro Documentation

Installation

Download and Unzip Figaro-Addon-1_1_0.zip.

You will see two zip files:

  • The_3DMage_AddonWrangler_1_0_0.zip
  • Figaro-1_1_0.zip

DO NOT UNZIP THESE TWO ZIP FILES!


Follow the installation instructions according to your version of Blender:

Blender 4.0 – 4.1

  1. Go to Edit > Preferences Icon Preferences.
  2. Click the Add-ons tab.
  3. Click the Install Icon Install button.
    1. Select The_3DMage_AddonWrangler_1_0_0.zip and then click Install Add-on.
    2. Enable System: 3D Mage Addon Wrangler if not already enabled.
  4. Click the Install Icon Install button again.
    1. Select Figaro-1_1_0.zip and then click Install Add-on.
    2. Enable Mesh: Figaro if not already enabled.
  5. Save your preferences.

Blender 4.2+

  1. Go to Edit > Preferences Icon Preferences.
  2. Click the Add-ons tab.
  3. Click the Add-ons Settings Icon Add-ons Settings button on the top right corner of the window.
    1. Click Install from Disk.
    2. Select The_3DMage_AddonWrangler_1_0_0.zip and then click Install from Disk.
  4. Click the Add-ons Settings Icon Add-ons Settings button again on the top right corner of the window.
    1. Click Install from Disk.
    2. Select Figaro-1_1_0.zip and then click Install from Disk.
  5. Save your preferences.

Quick Start Guide

  1. In Object Mode, open the Figaro Side Panel menu by clicking the Figaro tab.
  2. Click Create Figaro Object to create a new Figaro object. Make sure it is selected.
  3. Go to Edit Mode:
    • Extend edges and fill faces to build a shape.
    • Press Shift + R on selected vertices to enter Radius Mode:
      • Move mouse right to increase radius.
      • Move mouse left to decrease radius.
      • Left-click or press Enter to confirm.
      • Right-click or press Esc to cancel.
  4. When the Figaro object is finished, go to Object Mode and in the side panel menu, convert the object to a mesh either by:
    • Clicking Convert to Voxel Mesh for a voxel-based model.
    • Clicking Convert to Mesh for a standard mesh.

Object Mode Operations

Creating a Figaro Object

From Side Panel

  1. Make sure you are in Object Mode.
  2. Make sure the side bar is visible. Open the Figaro Side Panel menu by clicking on the Figaro tab on the viewport.
  3. If not already expanded, click Create Figaro Objects or the dropdown arrow to expand the tool options.
  4. Click the Create Figaro Object button. This will create a new Figaro object at the 3D cursor.

From Add Menu

  1. Make sure you are on Object Mode.
  2. Open the Add Menu either by shortcut key or by clicking Add from the header.
  3. Click Figaro Object. This will create a new Figaro object at the 3D cursor.

Converting to a Figaro Object

From Side Panel

  1. Make sure you are on Object Mode.
  2. Select object(s) you wish to convert to a Figaro object(s).
  3. Make sure the side bar is visible. Open the Figaro Side Panel menu by clicking on the Figaro tab on the viewport.
  4. If not already expanded, click Create Figaro Objects or the dropdown arrow to expand the tool options.
  5. Click the Convert to Figaro Object button. This will convert the selected object(s) into a Figaro object(s).

Converting Figaro Object to a Mesh

From Side Panel

  1. Make sure you are on Object Mode.
  2. Select Figaro object(s) you wish to convert to a mesh(es).
  3. Make sure the side bar is visible. Open the Figaro Side Panel menu by clicking on the Figaro tab on the viewport.
  4. If not already expanded, click Convert to Mesh or the dropdown arrow to expand the tool options.
  5. Click the Convert to Mesh button. A message will show up in the 3D viewport while the operation is running.
  6. The operation is complete when the message within the viewport disappears.

Converting Figaro Object into a Voxel Mesh

From Side Panel

  1. Make sure you are on Object Mode.
  2. Select Figaro object(s) you wish to convert to a mesh(es).
  3. Make sure the side bar is visible. Open the Figaro Side Panel menu by clicking on the Figaro tab on the viewport.
  4. If not already expanded, click Convert to Voxel Mesh or the dropdown arrow to expand the tool options.
  5. Adjust the Voxel Size and Adaptivity options to your liking. Toggle Use Smooth Shading to make the resulting voxel mesh use smooth shading.
  6. Click the Convert to Voxel Mesh button. A message will show up while the operation runs.
  7. The operation is complete when the message within the viewport disappears.

Display Options

Solid Display Viewport Shading

If using the Solid Display Viewport Shading option, the Figaro Side Panel will have a section called Display Color Options. Here, you can change the display color of the selected Figaro object(s) if the Use Object Color option is enabled.

To enable Use Object Color, click the checkbox located beneath the Display Color option.

To change Display Color, click the color picker and select a color. The selected Figaro objects’ color will match the new color. If multiple Figaro objects are selected, they will also have their color match the new color.

Material Preview / Rendered Viewport Shading

If using the Material Preview or Rendered Viewport Shading option, the Figaro Side Panel will have a section called Material Options. This is where you will assign a material to use for the Figaro object. The Figaro object will use the first material slot within the material list in the Material Properties menu. Updating the material via the side panel will update the first slot of the Material Properties materials list.

Geometry Options

You can adjust geometric properties of the selected Figaro object(s). There are three main options:

  • Segments: The number of longitudinal edges around spheres and cylinders (min 12, max 64).
  • Rings: The number of latitudinal edges around spheres (min 6, max 64).
  • Use Smooth Shading: Whether to use smooth or flat shading on the Figaro object.

To adjust the geometry options of the selected Figaro objects:

  1. Make sure you are in Object Mode.
  2. Select Figaro object(s) you wish to adjust.
  3. Open the Figaro Side Panel menu by clicking on the Figaro tab.
  4. If not already expanded, click Geometry Options or the dropdown arrow to expand.
  5. Adjust Segments and Rings using the slider or by typing the value. Toggle Use Smooth Shading as desired.

Removing Figaro Object Properties

You can remove the properties that were added to make an object a Figaro object. To remove these properties, select the objects in Object Mode and press the Remove Figaro Object Properties button.

Edit Mode Operations

Edit Mode is where you modify the shape of the Figaro object and adjust the radii of vertices.

Radius Mode

Each vertex has a radius value. The primary operation to adjust the volume of the Figaro object is Radius Mode on selected vertices. Activate by pressing Shift + R or clicking Radius Mode (Shift + R) in the side panel.

When in Radius Mode, you will see an icon in the middle of the viewport and a colored circle at the mouse cursor. The radius of selected vertices increases as the cursor moves right, and decreases as it moves left.

To confirm the operation, press Left-click or press Enter. To cancel the operation, press Right-click or press Esc.

In the bottom-left corner of the viewport, you can see the current state (delta radius, sensitivity, resize mode). In the bottom-right is a graphic showing shortcuts.

Side Panel Operations

Selected Vertex Radii Table
This table shows the radii of each selected vertex. You can toggle Show Vertex ID and Show Object columns if working with multiple objects.

Radius
Set the radii of all selected vertices immediately by changing this value.

Resize Mode
There are two ways to modify the radii while in Radius Mode:

  • Proportional: scales the radius multiplicatively (uniform changes).
  • Linear: scales the radius additively (useful for objects with very small radii).

You can switch modes on the fly by pressing the M key.

Sensitivity
Controls how fast the radius changes in Radius Mode (1–100, default 50). While in Radius Mode, hold Ctrl + Shift and scroll to adjust. Press ~ to reset to 50.

Radius Mode (Shift + R)
This button triggers Radius Mode on all selected vertices. (Shortcut: Shift + R)

Radius Mode Display Options

  • Hide Guides: hides the visual guides shown in Radius Mode.
  • Hide Stats: hides the numerical stats in bottom left corner shown in Radius Mode.
  • Hide Shortcuts: hides the shortcuts diagram shown in Radius Mode.

Apply Figaro Geometry Node from Modifier Stack

If you want to apply the Figaro Geometry Node directly from the modifier stack, you will need to make sure to check the "ManualApplyModifier" checkbox within the modifier itself before doing so. Not checking this option will cause the spheres to not be present after applying the modifier.

It is recommended that you use the Convert to Mesh or Convert to Voxel Mesh buttons on the Figaro Side Panel in Object Mode.

Useful Tips

  • Add a mirror modifier to the Figaro object for easy symmetrical modeling.
  • Using triangular faces could resolve arbitrary non-planar surface issues.
  • Separating the Figaro object into multiple Figaro objects can help with organization and modularity.