Skip to main content

Installing Plugins

Add, configure, and manage plugins from the Plugins modal.

Open the Plugins Modal​

  1. Open the menu drawer
  2. Click Plugins

Plugins modal

Adding a Plugin from File​

  1. Open the Plugins modal
  2. Click Import
  3. Select a .lua file from your computer
  4. Review requested permissions
  5. Click Approve & Install

The plugin is installed and enabled immediately.

Installing from URL​

Install plugins directly from an HTTP(S) URL:

  1. Open the Plugins modal
  2. Click URL
  3. Paste a URL that points to a .lua plugin file
  4. Click Install
  5. Review name, version, permissions, and events
  6. Click Approve & Install

URL-installed plugins keep their source URL so they can be checked for updates.

note

Only http:// and https:// URLs are supported. Plugin source files must be under 1MB.

Reviewing Permissions​

Before install/update, review the permission summary:

Network Access​

Shows allowed domains and methods (including wildcard subdomains if declared).

Filesystem Access​

Shows whether the plugin requests read and/or write access.

Folder-level access is approved when the plugin first attempts filesystem operations.

Clipboard Access​

Shows whether the plugin can write to system clipboard.

Events​

Shows the event subscriptions declared by the plugin manifest.

Configuring Plugin Settings​

If a plugin defines settings:

  1. Open the Plugins modal
  2. Click the plugin card to expand details
  3. Edit fields in the Settings section

Settings are saved automatically as you edit.

Expanded plugin details

Enabling and Disabling Plugins​

  1. Open the Plugins modal
  2. Use the toggle switch on the plugin row

Disabled plugins:

  • Do not respond to events
  • Do not run scheduled tasks
  • Keep their settings and permissions

Revoking Filesystem Permissions​

  1. Expand a plugin card
  2. In Permissions, click Revoke next to a granted path

The plugin must request access again the next time it needs that location.

Removing a Plugin​

  1. Expand the plugin card
  2. Click Remove Plugin
  3. Confirm removal

Removal deletes:

  • Plugin code
  • Granted permissions
  • Plugin storage/settings data

Updating Plugins​

Manual Updates​

For URL-installed plugins, click Update on the plugin row.

  • If no new permissions are required, update applies immediately
  • If permissions changed, a review dialog appears first
  • If update fails, the previous version is restored automatically

Automatic Update Checks​

Set the global update-check policy in Settings:

  1. Open menu drawer
  2. Click Settings
  3. In Plugin Updates, choose an interval:
    • On startup only
    • Every 6 hours
    • Every 24 hours
    • Disabled

When an update is available, an Update available label appears on the plugin row.

Troubleshooting​

Plugin shows error/disabled status​

A plugin is auto-disabled after repeated handler failures.

Try:

  • Re-enable the plugin after fixing settings
  • Update or reinstall the plugin
  • Remove the plugin if it is no longer maintained

Plugin not responding to events​

Check that:

  • The plugin is enabled
  • The plugin actually subscribes to the event
  • Required permissions were approved

Repeated filesystem prompts​

The plugin is requesting new paths not previously approved.

  • Approve the needed folder(s)
  • Or adjust plugin settings so it targets expected directories only