Files to help bootstrap PySide2 with an event loop within Blender.
Project description
bqt
Add QT support to Blender, letting you create custom UI for your addons with PySide2 QtWidgets.
Features
feature | description |
---|---|
fully custom UI | Instead of feeling limited by N-Panel only UI. Do whatever you want. |
cross app | Qt widgets run nativaly in Krita, 3ds Max, Maya, … and are great to use in cross dcc pipelines |
existing community | hundreds of QT widgets on GitHub you can reuse, and lots of stack exchange questions answered regarding qt. |
Themed | BQT ships with a basic blender theme, so qt widgets will by default look similar to Blender. |
Requirements
Blender 2.83
or higher.
Windows (stable) or Mac (experimental)
Installation
install as addon (recommended)
- Download the latest release. You can download the zip from the repo.
- Extract the zip and copy the
bqt
folder to your blender addons folder. - Enable the addon by going to
Edit > Preferences > Add-ons
and search forqt
PIP install
The installation of bqt with automatic setup for Blender requires the usage of the integrated python
interpreter found within ../Blender Foundation/<version>/Python/bin
python.exe -m pip install bqt
Installing from Source
If you are installing from a clone of the repository you can easily install by navigating to bqt's root folder and running:
python setup.py install
Develop setup
When working on the bqt code from a repo, to prevent having to reinstall bqt every time you make a change, you can symlink the bqt folder to your blender addons folder to develop bqt. Any updates in the repo are then reflected in blender on restart. e.g.:
mklink /J "C:\Users\USERNAME\AppData\Roaming\Blender Foundation\Blender\2.93\scripts\addons\bqt" "C:\Users\hanne\OneDrive\Documents\repos\_Blender\bqt\bqt"
Environment variables
variable | description |
---|---|
BQT_DISABLE_STARTUP | if set to 1 , completely disable bqt |
BQT_DISABLE_WRAP | if set to 1 , disable wrapping blender in a QWindow |
BQT_DISABLE_CLOSE_DIALOGUE | if set to 1 , use the standard blender close dialogue |
BQT_MANAGE_FOREGROUND | defaults to 1 , if 0 , widgets registered with bqt.register(my_widget) won't stay in the foreground when using Blender. |
BQT_AUTO_ADD | defaults to 1 , if 0 top level widgets won't automatically be added to bqt. |
- if you modify env vars, ensure they're strings
- if you're unsure how to set env vars, google
set environment variable windows
. - Restart Blender (or your computer) after changing them.
Sample code
bqt_demo shows you how to use bqt with several qt demos you can run in Blender
Community
Discuss BQT on
- the BlenderArtists thread
- Ynput thread
Alternative
- Custom UI for Blender only: https://github.com/mmmrqs/bl_ui_widgets
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.