SolarFM/plugins
itdominator ee3e042b1b Updated ytdlp version 2023-08-13 20:13:21 -05:00
..
archiver Plugin cleanup and tweaks 2023-02-20 19:18:45 -06:00
disk_usage added images to plugin menu options, added testing for generators, attempted mitigation of memory leak 2023-05-16 21:26:00 -05:00
favorites Plugin cleanup and tweaks 2023-02-20 19:18:45 -06:00
file_properties Plugin cleanup and tweaks 2023-02-20 19:18:45 -06:00
git_clone Added Singleton class to inherit as needed 2023-03-27 20:07:17 -05:00
movie_tv_info Plugin cleanup and tweaks 2023-02-20 19:18:45 -06:00
py_run Added debugger setup, cleanup 2023-04-29 09:44:22 -05:00
searcher Cleanup of widgets, fixing or updating plugins 2023-03-04 21:45:29 -06:00
template Added debugger setup, cleanup 2023-04-29 09:44:22 -05:00
translate Restructured settings logic and loading; translate fix 2023-07-29 23:42:59 -05:00
trasher added images to plugin menu options, added testing for generators, attempted mitigation of memory leak 2023-05-16 21:26:00 -05:00
vod_thumbnailer WIP implimentig new files widget, updated settings, broke keybindings 2023-02-23 23:03:29 -06:00
youtube_download Updated ytdlp version 2023-08-13 20:13:21 -05:00
README.md Rewired settings, improved plugin structural coupling, cleanedup session file generation n load 2022-10-09 20:59:44 -05:00

README.md

Note

Copy the example and rename it to your desired name. Plugins define a ui target slot with the 'ui_target' requests data but don't have to if not directly interacted with. Plugins must have a run method defined; though, you do not need to necessarily do anything within it. The run method implies that the passed in event system or other data is ready for the plugin to use.

Manifest Example (All are required even if empty.)

class Manifest:
    name: str     = "Example Plugin"
    author: str   = "John Doe"
    version: str  = "0.0.1"
    support: str  = ""
    requests: {}  = {
        'ui_target': "plugin_control_list",
        'pass_fm_events': "true"
    }

Requests

requests: {}  = {
    'ui_target': "plugin_control_list",
    'ui_target_id': "<some other Gtk Glade ID>",          # Only needed if using "other" in "ui_target". See below for predefined "ui_target" options...
    'pass_fm_events': "true",                             # If empty or not present will be ignored.
    "pass_ui_objects": [""],                              # Request reference to a UI component. Will be passed back as array to plugin.
    'bind_keys': [f"{name}||send_message:<Control>f"],
                  f"{name}||do_save:<Control>s"]          # Bind keys with method and key pare using list. Must pass "name" like shown with delimiter to its right.

}

UI Targets:

  • main_Window
  • main_menu_bar
  • path_menu_bar
  • plugin_control_list
  • window_(1-4)
  • context_menu
  • other