LOGIK_PORTAL // PYFLAME
--:--:--  ·  SYS:OK  ·  CONN:ACTIVE  
$ import pyflame

PYFLAME
LIBRARY_

v5.5.3  ·  FLAME 2025.2+  ·  PYTHON 3.11 – 3.13  ·  PYSIDE6

A Python library for Autodesk Flame.

autodesk flame python library pyside6 qt widgets

PyFlame is a Python library containing a set of custom Qt widgets for Autodesk Flame — all styled to match Flame's native UI — along with layout helpers, window classes, a config system, and utility functions for script development.

The library file should be renamed per-script to pyflame_lib_<script_name>.py and placed in the script's lib/ folder, avoiding version conflicts when multiple scripts coexist in the Flame Python folder. It requires the Montserrat font family (included in assets/fonts/) to render correctly. These fonts are included in the PyFlame library.

Flame Version2025.2+
Python Version3.11 – 3.13
Qt BindingPySide6
PlatformRocky Linux  ·  MacOS
Version5.5.3  ·  Updated 10.16.26
LicenceMIT License  ·  see the LICENSE file
v5.5.3
10.16.26
  • Changed license from GPL-3.0 to MIT. See LICENSE file for details.
v5.5.2
10.08.26
  • Fixed "screenGeometry" error for Flame 2027.2
v5.5.1
08.11.26
  • Widgets
    • PyFlameMenu
      • Updated stylesheet - menu bar now changes to grey when disabled.
  • PyFlameConfig
    • Now neatly prints lists and dictionaries to the console.

Full history: CHANGELOG.md

All scripts using PyFlame must follow this layout. Rename the library file per-script to avoid conflicts when multiple scripts are installed simultaneously.

The script folder, script name, and library file name must all be the same.

Folder structure:

script_folder/
 ├── main_script.py
 ├── lib/
 │   └── pyflame_lib_<script_name>.py
 │   └── README.md              # optional
 │   └── CHANGELOG.md           # optional
 └── assets/
      └── fonts/
          └── Montserrat-Regular.ttf
          └── Montserrat-Light.ttf
          └── Montserrat-Thin.ttf


Example folder structure for script named "rename_shots":

rename_shots/
 ├── rename_shots.py
 ├── lib/
 │   └── pyflame_lib_rename_shots.py
 │   └── README.md              # optional
 │   └── CHANGELOG.md           # optional
 └── assets/
      └── fonts/
          └── Montserrat-Regular.ttf
          └── Montserrat-Light.ttf
          └── Montserrat-Thin.ttf

Import everything from the library into the script's namespace. Call the utility functions through the pyflame object (the library's _PyFlame helper class) and instantiate widgets directly by class name.

# Import everything from the library
from lib.pyflame_lib_my_script import *

# Call utility functions via the pyflame object
pyflame.print("Script loaded")
flame_version = pyflame.get_flame_version()

# Instantiate widgets directly
window = PyFlameWindow(title='My Script')
button = PyFlamePushButton(text='Run', connect=my_function)
menu = PyFlameMenu(text='Options', menu_options=['A', 'B', 'C'])
window.grid_layout.addWidget(button, 0, 0)
window.grid_layout.addWidget(menu, 0, 1)
window.show()

Click any widget to see its description, parameters, and a usage example.

// WIDGETS
PyFlameButton
PyFlameEntry
PyFlameEntryBrowser
PyFlameImageWidget
PyFlameImageGallery
PyFlameLabel
PyFlameListWidget
PyFlamePushButton
PyFlameMenu
PyFlameColorMenu
PyFlameTokenMenu
PyFlameSlider
PyFlameTable
PyFlameTabWidget
PyFlameTextEdit
PyFlameTextBrowser
PyFlameTreeWidget
PyFlameProgressBarWidget
PyFlameButtonGroup
PyFlameHorizontalLine
PyFlameVerticalLine
// LAYOUTS
PyFlameGridLayout
PyFlameHBoxLayout
PyFlameVBoxLayout
// WINDOWS
PyFlameWindow
PyFlameOptionWindow
PyFlameInputDialog
PyFlameMessageWindow
PyFlamePasswordWindow
PyFlameProgressWindow
// UTILITY
PyFlameToolTip
PyFlameConfig
SELECT A WIDGET

All utility functions are accessed through the pyflame object after importing the library.

Click any function to see its description, arguments, and usage examples.

// SELECT FUNCTION
cleanup_temp_folder
convert_export_preset_name_to_path
copy_to_clipboard
copy_to_shot_folder
create_file_system_folder
create_file_system_folders
create_media_panel_folder
create_media_panel_folders
create_media_panel_libraries
create_temp_folder
cursor_busy
cursor_restore
file_browser
find_by_tag
font_resize
generate_unique_name
generate_unique_node_names
get_export_preset_names
get_export_preset_version
get_flame_python_packages_path
get_flame_version
get_media_panel_shot_folder
gui_resize
iterate_name
move_to_shot_folder
open_in_finder
pause
print
print_dict
print_json
print_list
print_title
python_package_local_install
raise_type_error
raise_value_error
refresh_hooks
resolve_shot_name
resolve_tokens
set_shot_tagging
shot_name_from_batch_group
shot_name_from_clip
untar
update_export_preset
verify_script_install
window_resolution
SELECT A FUNCTION