<blockquote>{{Info|text=If you do not see the plugins manager, follow the instructions [https://plover.wiki/index.php/Troubleshooting_Issues#Disappearing_plugins_manager here] to bring it back.}}</blockquote>
<blockquote>{{Info|text=If you do not see the plugins manager, follow the instructions [[Troubleshooting_Issues#Disappearing_plugins_manager|here]] to bring it back.}}</blockquote>
=== Manually Installing Plugins ===
=== Manually Installing Plugins ===
Some plugins are not yet in the registry and do in the show up in the plugins manager list. It is still possible to manually install plugins. '''Ensure you are running Plover 4.x – version 3 and below do not include plugin support.'''
Some plugins are not yet in the registry and do in the show up in the plugins manager list. It is still possible to manually install plugins. '''Ensure you are running Plover 4.x – version 3 and below do not include plugin support.'''
Revision as of 15:43, 12 May 2025
Plugins can be made for Plover to extend its functionality in various ways, from the tools available in the GUI to the types of dictionaries supported. They are available starting from Plover version 4.0.
How to Install Plugins
Via the built-in Plugins Manager (recommended)
Open the main window of Plover.
You can also right click on the Plover icon.
Go to Tools → Plugins Manager.
Browse the available plugins and select the one you want to install.
Select Install/Update to install the plugin.
Press Yes to the security warning.
Once the plugin has finished installing, close the progress window.
If you do not see the plugins manager, follow the instructions here to bring it back.
Manually Installing Plugins
Some plugins are not yet in the registry and do in the show up in the plugins manager list. It is still possible to manually install plugins. Ensure you are running Plover 4.x – version 3 and below do not include plugin support.
Open a command line (Command Prompt app on Windows, Terminal on Linux and macOS).
Type git and press enter.
You should see something the following output:
If the above command does not work, first verify you've installed git. If you are still running into an error when trying to run git, you may have to restart or manually add git to your path (particularly if you are on Windows).
Install the plugin
Installing the plugin requires accessing the Plover executable as outlined in the invoke Plover from the Command Line page. For each command listed below, replace plugin-name with an applicable string:
For plugins on PyPI, this is the name of the package (e.g., plover-touchscreen-stenotype).
For other plugins, this is the URL from the previous step, prefixed with git+ (e.g., git+https://github.com/greenwyrt/plover2CAT).
Linux
Open a terminal in the same folder as the Plover AppImage and run the following command:
Note that depending on the version of Plover you are using, the first part of the command may be different. Instead of typing the whole filename out, you can type ./plover and then press Tab to autocomplete the rest.
TODO: Information on how to install the plugins manager for non-developers, screenshots, point developers towards the development workflow section which has other options.
Spectra Lexer This is like the lookup or suggestions window, but with a lot of extra features such as explanations for why a word is briefed that way and diagrams. There is also a web version and a bot in the discord server, though these only use the default Plover dictionaries and not any additional user dictionaries you may have.
Plover-clippy or Plover-clippy-2 Logs suggestions that are more efficient than what you used to type to a file in your plover configuration directory. Useful for finding new briefs, especially for phrases. By default the output of Plover-clippy-2 is written into clippy_2.org in your config folder, which you can open from Plover's menu item "Open config folder". Open the clippy file in a text editor and review it from time to time to see what you could type more efficiently.
Plover Word Tray Automatically looks up efficient outlines for words that start with the current input, much like autocomplete suggestions. It's similar to the lookup window and suggestions window in one. In addition, if you are stuck on a word, you can start fingerspelling it or sound out the first syllable and it'll try to guess what you're trying to spell.
Dictionary Plugins
Dictionary plugins add support for other dictionary formats besides Plover’s native JSON format.
There is no setup required for these plugins beyond installation and restarting Plover.
Machine Plugins
Machine plugins add support for new input protocols, such as the serial input from various professional stenography machines or even MIDI keyboards.
These plugins add new entries in the Machine dropdown menu in Plover's configuration.
System Plugins
System plugins defines new key layouts and theories. This lets Plover support stenographic layouts other than the standard American Stenotype system, such as Michela (plover-michela) or Korean CAS (plover-korean).
To use a system plugin, configure it under the System tab of Plover's configuration.
Command Plugins
Commands plugins allow Plover to run arbitrary commands in response to a stroke. The logic can interact with the stenography engine itself but can also do completely separate tasks.
See the plugin's own documentation for setup details.
Macro and Meta Plugins
Macro and meta plugins add or modify translations in the translator, typically for transforming previously entered text. Macros have access to the entire translation and can perform transformations on the raw stroke input, whereas metas only have access to the translated output.
To use macro and meta plugins, see the plugin's own documentation for setting up entries.
GUI Plugins
GUI plugins add user-facing tools, like the built-in Suggestions and Lookup tools. GUI plugins are automatically loaded at startup, and can be accessed by clicking on its icon on the toolbar or in the Tools dropdown menu.
There is no setup required for these plugins beyond installation and restarting Plover.
Extension Plugins
Extension plugins can be used to execute arbitrary code.
To use an extension plugin, it must be enabled in the Plugins tab of Plover's configuration.
