Skip to content

Production-grade Blender pipeline tool. Automates library linking, repairs broken overrides, and manages Rig UI scripts seamlessly

Notifications You must be signed in to change notification settings

MannanSaood/proref

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ProRef Header

Professional Referencing & Rig UI

Industry-grade character linking, override management, and rig UI handling for Blender

Blender Version License Version


Supported Formats

Format Extensions Features
Blender .blend Full linking with library overrides
FBX .fbx Animation, custom properties, bone orientation
USD .usd, .usda, .usdc, .usdz Pixar Universal Scene Description
Alembic .abc Baked geometry and animation caches
glTF .gltf, .glb Web and real-time 3D
OBJ .obj Legacy geometry exchange
Collada .dae Cross-platform XML exchange
PLY/STL .ply, .stl 3D printing and scan data

Features

Smart Character Linking

  • One-click linking/import with automatic library override creation
  • Multi-format support — blend, FBX, USD, Alembic, glTF, and more
  • Auto-make properties editable — no more teal fields
  • Unique naming to prevent conflicts with multiple characters
  • Animation Only Mode — skip mesh overrides for better performance

Rig UI Isolation

  • Automatic rig_ui.py detection and script isolation
  • Context-aware execution — each character gets its own UI context
  • Script safety validation — checks for unsafe Python patterns
  • Auto-execute on link option for faster workflow

Override Health System

  • One-click health diagnostics for all library overrides
  • Detect common issues: missing references, broken paths, locked properties
  • Automated repair tools with smart issue resolution
  • Targeted resync — resync single objects without affecting the entire hierarchy

Reference Manager

  • Visual library overview with file size and modification dates
  • Missing file detection with relocate functionality
  • Batch operations — reload, relink, version bump
  • Version detection — finds v01, v02, etc. and upgrades to latest

v1.5: Pipeline Features

  • Batch Relink — find and replace paths for drive migrations
  • Version Detection — auto-detect asset versions and upgrade
  • CLI/Headless Mode — render farm support with auto-fix on load
  • Environment Variables — use ${PROJECT_DIR} in paths

Installation

  1. Download the latest release ZIP file
  2. In Blender, go to Edit → Preferences → Add-ons
  3. Click Install... and select the ZIP file
  4. Enable "Professional Referencing & Rig UI"

Quick Start

Linking a Character

  1. Open the Pro Ref panel in the 3D Viewport sidebar (N key)
  2. Click "Smart Link Character"
  3. Browse to your character file (supports .blend, .fbx, .usd, .abc, .gltf, etc.)
  4. The character will be linked/imported with automatic setup

Running Health Checks

  1. Click "Run Health Check" in the Override Health panel
  2. Review any issues in the health checklist
  3. Click "Repair" to auto-fix common problems

Executing Rig UI

  1. Select your linked character's armature
  2. Click "Execute Rig UI" in the Rig UI Management panel
  3. The rig controls will appear in the Properties → Bone panel

Keyboard Shortcuts

Shortcut Action
Ctrl+Shift+L Smart Link Character
Ctrl+Shift+H Run Health Check
Ctrl+Shift+R Execute Rig UI
Ctrl+Shift+E Make All Editable

Shortcuts can be disabled in addon preferences.


Addon Preferences

Access via Edit → Preferences → Add-ons → Professional Referencing & Rig UI

  • Default Library Path — Set a default folder for browsing
  • Linking Defaults — Configure auto-make-editable and animation mode
  • Safety Settings — Enable/disable script validation
  • Keyboard Shortcuts — Enable/disable shortcuts

Troubleshooting

"Cannot find rig_ui.py script"

The addon searches for scripts with "rig_ui" in the name from the same library as the armature. Ensure your character file has a properly named rig UI script.

"Library file not found"

Use the Reference Manager → Relocate File button to point to the new location of your library file.

"Override properties not editable"

Click "Make All Editable" in the Quick Actions panel, or enable "Auto Make Editable" in Link Settings before linking.

Health check shows many issues

Run "Repair Override" to automatically fix common issues like missing editable properties and fully-locked bones.


Compatibility

  • Blender 3.6+ (tested up to 4.x)
  • Works with Rigify, Auto-Rig Pro, and custom rigs
  • Compatible with rig UI scripts that follow standard patterns

Support

For bug reports and feature requests, please open an issue on the GitHub repository.


License

This addon is licensed under the GNU General Public License v3.0 (GPL-3.0).


Credits

Developed for professional animation studios and individual artists who need reliable character referencing in Blender.

About

Production-grade Blender pipeline tool. Automates library linking, repairs broken overrides, and manages Rig UI scripts seamlessly

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages