Skip to content

Your First Plug-in

RoyiFileManager keeps fman's Python plug-in model.

Create this folder:

UserSettings/Plugins/User/Hello World/
├── hello_world/
│   └── __init__.py
└── Key Bindings.yaml

Add a key binding:

Key Bindings.yaml
# Say hi with Ctrl+Alt+H.
- keys: [Ctrl+Alt+H]
  command: say_hi

Add the command:

hello_world/__init__.py
from fman import DirectoryPaneCommand, show_alert


class SayHi(DirectoryPaneCommand):
    def __call__(self):
        show_alert("Hello World!")

Open the Command Center. Run Reload plugins.

Press Ctrl+Alt+H.

What Happened?

The class name SayHi became the command ID say_hi.

The host created the command and supplied its pane.

Next, see the API overview.

Manual Installation

Place trusted plug-in files under UserSettings/Plugins/Third-party/<PluginName>/. The Python package and configuration files belong directly inside <PluginName>.

Run Reload plugins in Command Center. List plugins opens a plug-in's folder; Remove plugin deletes an installed third-party plug-in. There is no built-in downloader, and no Plugin.json installation metadata is required.

Batch File Renamer Example

The independent Batch File Renamer demonstrates mapped QuickBoard previews, optional caller status and public no-overwrite renaming. New frozen builds include it automatically. Source runs and older compatible builds can install it manually as described above. Remove any old manual duplicate when upgrading to a bundled build. Its README lists the required host API and template syntax. For the user guide and examples, see Batch File Renamer.