### 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': "", # 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:f"], f"{name}||do_save: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
### Methods ``` # Must define and return a widget if "ui_target" is defined. def get_ui_element(self): button = Gtk.Button(label=self.name) button.connect("button-release-event", self._do_download) return button # Must define in plugin if "pass_fm_events" is set to "true" string. def set_fm_event_system(self, fm_event_system): self._fm_event_system = fm_event_system # Must define regardless if needed. Can just pass if plugin does stuff in its __init__ def run(self): self._module_event_observer() # Must define in plugin if "pass_ui_objects" is set and an array of valid glade UI IDs. def set_ui_object_collection(self, ui_objects): self._ui_objects = ui_objects ```