Blender Runner

Installation

1. Import the Blender Runner package into your Unity project
2. Ensure Blender is installed on your system
3. Open Unity and wait for scripts to compile

Note
Blender Runner works in both the Unity Editor and at runtime, but most features are intended for Editor use.

Opening Blender Runner

Open the main window via:

Window → URage → Blender Runner

This window is the central hub for all Blender Runner workflows and scripts.

Core Concepts

Settings Asset

Blender Runner uses a central Settings ScriptableObject to store all workflows.

Create one via:

Assets → Create → URage → BlenderRunner → Settings

The Settings asset contains a list of Workflows, which appear as tabs in the Blender Runner window.

Workflows

A Workflow represents a collection of Blender scripts that belong together.

Examples:

• FBX Cleanup
• Low Poly Conversion
• Material Baking

Create a Workflow via:

Assets → Create → URage → BlenderRunner → Workflow

Each Workflow:

• Has a display name
• Contains a list of Scripts
• Appears as a tab in the Blender Runner window

Scripts

A Script represents a single executable Blender task.

Create a Script via:

Assets → Create → URage → BlenderRunner → Script

Script Settings

• Script Name
  Display name in the UI
• Description
  Short explanation of what the script does
• Python Script
  The Blender .py file to execute
• Model Required
  Requires a selected model before execution

Arguments

Scripts can define arguments that are passed to Blender as command-line parameters:

--argumentName=value

Each argument supports:

• String
• Integer
• Float
• Boolean
• Mandatory flags
• Tooltips for user guidance

External Addons

If a script depends on non-built-in Blender addons, they can be listed here.

These addons are shown to the user with:

• Name
• Description
• Download URL

Execution Options

• Run in Background
  Runs Blender headless
• Use File System Watcher
  Automatically detects exported FBX files

Typical Workflow

1. Select a model in the Unity Project or Scene
2. Open Blender Runner
3. Select a Workflow tab
4. Select a Script
5. Fill in required arguments
6. Click Run

Blender will execute the script and return control to Unity.
If enabled, generated FBX files are automatically reimported and instantiated.

File System Watcher

When enabled, Blender Runner monitors the output directory for changes.

This allows Unity to:

• Detect newly exported FBX files
• Refresh the Asset Database
• Automatically instantiate results in the scene

Note
This feature is Editor-only and intended for rapid iteration workflows.

Best Practices

• Keep Blender scripts small and focused
• Use arguments instead of hardcoded values
• Group scripts logically into workflows
• Use background mode for batch processing