Skip to content

Installation Guide

Blender version compatibility

TraitBlender releases are paired with specific Blender version ranges. Install the add-on release that matches your Blender version:

TraitBlender Supported Blender versions
v2.0.0 4.3 through 5.0 (inclusive)
v2.1.0 5.1 and later

If you upgrade Blender outside the range supported by your installed TraitBlender build, upgrade TraitBlender as well (or stay on a Blender version within the supported range).

System Requirements

Minimum Requirements

  • Blender: Must fall within the range for your TraitBlender version (see table above): v2.0.0 supports Blender 4.3–5.0; v2.1.0 supports Blender 5.1+.
  • Operating System: Windows 10/11, macOS 10.15+, or Linux (Ubuntu 20.04+)
  • Blender: The newest Blender release that is still supported by your TraitBlender version (e.g. 5.0 with TraitBlender v2.0.0, or 5.1+ with v2.1.0)
  • RAM: 32GB for large datasets
  • CPU: Multi-core processor (8+ cores recommended)

Installation

Command-line install (optional)

You can install a downloaded release zip directly from the terminal:

blender --command extension install-file -r user_default --enable traitblender-v2.1.0-linux.zip

Use the zip that matches your OS:

  • Linux: traitblender-<tag>-linux.zip
  • Linux (headless): traitblender-<tag>-linux-headless.zip
  • macOS: traitblender-<tag>-mac.zip
  • Windows: traitblender-<tag>-windows.zip

Command-line Uninstall (Optional)

To remove TraitBlender from the Blender extension directory:

blender --command extension remove [-h] [--no-prefs] PACKAGES

Replace PACKAGES with the installed extension package name(s) you want to remove (the exact identifier can vary by OS/tag).

After removing the extension, restart Blender. TraitBlender will no longer be available (the UI panel and bpy.ops.traitblender.* operators will not be registered).

Step 1: Download TraitBlender

  • Download the latest release from GitHub Releases
  • Save the .zip file to your computer

Step 2: Install in Blender

  • Open Blender
  • Go to Edit > Preferences (or Blender > Preferences on macOS)
  • Navigate to the Add-ons tab
  • Click Install... button
  • Browse and select the downloaded TraitBlender .zip file
  • Click Install Add-on

Step 3: Enable the Add-on

  • In the Add-ons list, search for "TraitBlender"
  • Check the box next to "TraitBlender" to enable it
  • The add-on should now appear in the 3D Viewport sidebar (press N to show/hide)

Verify Installation

To verify that TraitBlender is properly installed:

Check the UI Panel

  • In the 3D Viewport, press N to open the sidebar
  • Look for the "TraitBlender" tab

If something is wrong

  • Ensure your Blender version matches your TraitBlender release (compatibility table)
  • Check that the add-on is enabled in Preferences
  • Restart Blender completely

Next Steps

After successful installation, proceed to the Quick Start Tutorial to begin using TraitBlender.