Boot Options

Added in version 2.0.3.

PME supports an external startup config file named boot_config.json. It is read before addon registration begins.

Note

Changes made here take effect on the next Blender startup.

Where to edit it

You can edit these options in Preferences > Settings > Developer.

Tip

Use Open Boot Config Folder to open the folder that contains boot_config.json.

OS

PME 2.1 Extension boot_config.json

Windows

%APPDATA%\Blender Foundation\Blender\<version>\config\pie_menu_editor\extension\boot_config.json

macOS

~/Library/Application Support/Blender/<version>/config/pie_menu_editor/extension/boot_config.json

Linux

~/.config/blender/<version>/config/pie_menu_editor/extension/boot_config.json

The Extension and Legacy addon use separate config files. The Legacy addon file is boot_config.json directly inside the same pie_menu_editor directory. Normally, use Open Boot Config Folder instead of entering the path manually.

This file is not overwritten by addon updates.

Enable import pme

If you want to use PME from external scripts or other addons via import pme, you must enable it explicitly.

Steps

  1. Open Preferences > Settings > Developer

  2. Turn on Enable import pme Alias

  3. Restart Blender

import pme
pme.invoke_pm("My Pie Menu")

Why is this opt-in?

A Blender Extension package name varies with its installation source, for example bl_ext.<repository>.pie_menu_editor. PME registers import pme as a short alias so external scripts do not have to hard-code that physical package name.

The alias is a top-level name shared by the Blender process, so PME keeps it opt-in. This setting controls only whether the alias is installed. The Public API remains Experimental.

Note

The Extensions UI may show these warnings after you enable the alias:

  • Policy violation with top level module: pme

  • Policy violation with top level module: pme.constants

Blender reports them because these modules are registered under top-level names outside the Extension’s bl_ext... namespace. For PME’s opt-in alias, this is expected and does not mean that PME failed to enable or that import pme is broken. If the alias works, no action is required. If you do not need the alias, turn the option off and restart Blender.

See also

See Public API for the current API reference.

Enable init logging

If PME has trouble during startup, init logging can help show where initialization stopped.

Enable it from Settings

  1. Open Preferences > Settings > Developer

  2. Turn on Enable Init Log

  3. Restart Blender

  4. Check Blender’s system console on Windows, or launch Blender from a terminal on macOS/Linux to see the startup log

Enable it by editing boot_config.json

If startup trouble prevents you from opening Preferences, or if you want to control the next startup from an external file, you can edit boot_config.json directly.

{
  "version": 1,
  "enable_public_api_alias": false,
  "init_log_enabled": true,
  "persistence_backend": "prefs",
  "dev": {
    "use_loader_manifest": true,
    "auto_generate_candidate": false
  }
}

If you already have a boot_config.json, change init_log_enabled to true. The change takes effect on the next Blender startup.

Enable it once from the command line

If you want init logging for a single run without changing your saved settings:

# macOS / Linux
blender --python-expr "import sys; sys.argv.append('--pme-log-init')" --

# Windows
blender.exe --python-expr "import sys; sys.argv.append('--pme-log-init')" --

Tip

The --pme-log-init flag takes priority over the stored setting. Use it when you want temporary startup logs without editing boot_config.json.

Where to read the log

  • Blender system console

  • Preferences > Settings > Log

Reset

To reset all boot options, delete boot_config.json. It will be recreated with default values on the next startup.

Warning

If boot_config.json is broken, PME still starts with defaults instead of failing startup.