Custom Icons¶
Use your own PNG icons in PME.
Basics¶
Format: PNG (only files with the
.pngextension are loaded).Location: a folder registered under Settings > Resources > Icon Folders. By default this is the
icons/folder in your user resource directory. See File Locations for paths on each OS.On Windows:
%USERPROFILE%\Documents\Pie Menu Editor\icons\my_icon.pngTo use another set of icons, add its folder under Icon Folders.
Names: the filename without its extension becomes the icon name (
my_icon.png→my_icon). Match it exactly, including case and spaces.
Tip
Use Open Folder in an Icon Folders row under Preferences > Settings > Resources to open that folder directly. The folder is preserved during add-on updates, so your icons do not need to be moved for an update.
Loading and refreshing icons¶
Icons load when Blender starts and the add-on is enabled. After adding or changing a PNG, press the refresh button () in the icon selector’s Custom tab.
Added in version 2.1: Custom icons can be reloaded without restarting Blender.
Using a custom icon¶
View and select loaded icons in the icon selector’s Custom tab.
An unknown name may display a fallback Blender icon.
Using icons in scripts (optional)¶
PME wrapper: pass a string containing
@directly.# With LayoutHelper lh.operator("wm.operator", text="Run", icon='@my_icon')
Blender UI API: combine
icon='NONE'withicon_value.# Directly from Python from pie_menu_editor.previews_helper import custom_icon layout.operator("wm.operator", text="Run", icon='NONE', icon_value=custom_icon("my_icon"))
Naming and image quality¶
Prefer ASCII letters, numbers, and
_to reduce typing errors.Use a PNG with a transparent background.
Any resolution is accepted; around 32–64 pixels square is usually readable.
Troubleshooting¶
Missing or incorrect icon
Check the
.pngextension.Check that the filename without its extension matches the requested name (
@name) exactly.Refresh the Custom tab after adding or changing a file.
Icon missing from the list
Place it directly inside a registered icon folder; subfolders are not scanned.
Try saving the image again to rule out a damaged file.
Reload with the refresh button.
Included samples¶
Samples such as p1.png, p2.png, and pA.png are initially copied into the user resource icons/ folder. Use them as @p1, @pA, and so on.
Quick steps¶
Place PNG files in a registered icon folder (open it from its Icon Folders row in Settings > Resources).
Press refresh in the icon selector’s Custom tab.
Use
@filenamein PME.