Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 3.85 KB

README.md

File metadata and controls

74 lines (57 loc) · 3.85 KB
Raw

Welcome to Flow Launcher's plugins repository

This repository contains the information for community-made plugins used in Flow and how to make new submissions.

AutoUpdate

Plugin list

Looking for a list of currently available plugins in Flow? Visit here

How to submit your plugin

  1. Create a file named ${name}-${uuid}.json in the plugins directory.
  2. Copy these items from your plugin project's plugin.json file:
    • ID
    • Name
    • Description
    • Author
    • Version
    • Language
    • Website
  3. Add UrlDownload, UrlSourceCode, and IcoPath to the file.
  4. It should look like this: 
    {
  "ID": "Unique GUID from your plugin.json",  
  "Name": "Plugin name",
  "Description": "Short description",
  "Author": "Author",
  "Version": "Version from your plugin.json",
  "Language": "Programming language",
  "Website": "Plugin website",
  "UrlDownload": "URL to download",
  "UrlSourceCode": "URL to source code",
  "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher/Plugins/Flow.Launcher.Plugin.Explorer/Images/explorer.png"
}
  5. For IcoPath, use a CDN provider for global accessibility. jsdelivr.com for example as shown above, works well with GitHub repositories.
  6. It is a requirement to set up a GitHub Actions workflow for automated build and release. Follow the guide here and use this as an example.
  7. It is a requirement that your plugin conforms with the Plugin Store policy.
  8. Submit a pull request.
  9. The plugin will be available in Flow after the pull request is approved by the Flow Launcher Team.

Flow downloads the manifest (plugins.json) file from various CDN providers, which means the availability of your new plugin depends on when these providers sync their updated files. This syncing process can take several days and sometimes up to a week across all providers. During this period, you may see intermittent updates for your plugin in the manifest, as the provider chosen for retrieval is selected randomly based on the fastest fetch speed.

While the plugin has not yet appeared in the store, you and your users can manually install it using pm install <url/local path>.

Plugin updates

Every three hours the CI in this repository will check for new updates from plugins and automatically update them to the latest version.

Plugin Store policy

Plugins that facilitate or contain any of the following will not be allowed:

  • Malicious code
  • Piracy
  • Deceptive use
  • Inappropriate content
  • Illegal activities
  • Impersonation
  • Abuse
  • Fraud
  • Spam

Plugin Store

Users will be able to install your plugin via the store or type pm install <your-plugin-name>:

Have a plugin enhancement request or issue?

This repository does not track enhancement requests or issues for plugins, it is up to the plugin developers to maintain their own plugin.

If you would like to contribute, submit a request or issue, please visit the plugin's repository via the 'UrlSourceCode' link or from pm install, shift enter/right click on the plugin to go to the context menu and select 'Suggest an enhancement or submit an issue'.