-
Notifications
You must be signed in to change notification settings - Fork 277
Installation Guide
Table of Contents
- Troubleshooting
- Download Plover
- Migrating from v3 to v4
- Installation
- Setting up my machine
- For developers: running from source
If you get stuck, you can:
- Check the troubleshooting guide.
- Search for your problem in our issue tracker and our Discussions forum.
- If you can't find your particular problem, open a support request or start a Discussion.
We also have a Plover Discord Server, the steno community, and a GitHub Discussions forum if you have a general idea or discussion topic.
Note: It is currently recommended to download the unreleased Plover version 4 even if it is not considered "stable" yet. Version 3 is outdated and may not work on some operating systems and contains known bugs.
Go to this page to download the latest recommended release 🚀
Scroll down to "assets" and see below for which file to download for your operating system:
You can also get in-development versions of Plover by downloading the continuous release or by visiting releases.
Backing up your configuration: Your version 3 configuration file can be read by version 4, but once version 4 is launched it will overwrite the configuration file with a new format, which means that version 3 will no longer have your settings. You can back up your plover.cfg in case you need to go back to version 3.
Dictionary updates: The dictionary has seen some upgrades over time, and by default Plover will not overwrite old versions of dictionaries. See the guide on upgrading the dictionaries to the newest version.
Each release has files for all the operating systems we support. You only need the files that are relevant to your operating system
Plover is available as an installer (recommended) or as a portable ZIP, useful for running off of a USB stick or with restricted permissions.
Installer: Download the "Windows: Installer", launch it, and follow the instructions to install Plover. You may need to grant permissions for the app to bypass Windows Defender SmartScreen.
Portable ZIP: Download the "Windows: Portable ZIP" and extract the entire folder inside to the location that you'd like to run Plover from. Inside the folder, run plover.exe to start Plover.
- Download the "macOS: Disk Image" file under "Assets" from the releases page.
- Open the
.dmgfile. - In the mounted disk, drag the
Plover.appto yourApplicationsfolder. - Open the Applications folder, and follow the guide to launch a program from an unidentified developer.
- Open
System Preferences > Security & Privacy > Privacy > Accessibility. - Click the "+" Button, and go to your applications and select
Plover.app.
If you use a keyboard instead of a steno machine, Plover needs Assistive Device Permissions. From the Catalina version of macOS, you may need to enable the Plover app under Security & Privacy > Privacy > Accessibility.
Plover is set up! You can run Plover like you would any other application.
Note: Other "keyboard helper"-type applications (e.g. Karabiner Elements and text expanders) may interfere with Plover.
If you have Homebrew Cask installed on your system, you can run brew install --cask plover at the command-line.
(Arch Linux), (Gentoo), (Void Linux)
An AppImage is provided: it includes all the necessary dependencies and should run on most x86 64-bits distributions. To use it:
- Download it
- Make it executable
- Launch it like a standard executable
Note: you can install the AppImage for your current user (and register Plover in your standard applications menu) by executing it with the
--installflag. If you had previously installed another AppImage version of Plover, it will be automatically uninstalled and replaced.
For devices such as the Georgi and Tiny Mod which have serial modes (Gemini PR, or TX Bolt), you will have to add yourself to the uucp or dialout groups depending on your distro. These are the owners of /dev/ttyACM*, which is usually where your keyboard will show up. You can run ls -l /dev/ttyACM* when your keyboard is plugged in to find out which group owns the port.
To add a user to a group, you can use the command sudo usermod -aG <group> <user>. You will need to restart your session for the changes to apply.
For example: sudo usermod -aG dialout bob or sudo usermod -aG uucp sue.
If the following error occurs when running the AppImage:
Could not load the Qt platform plugin "xcb" in "" even though it was found. This application failed to start because noQt platform plugin could be initialized. Reinstalling the application may fix this problem.
Ensure that libxcb, xcb-util and qt5-qtstyleplugins are installed (or whatever the equivalent packages are on your distro).
If the error still persists, run the following:
./plover.AppImage -s plover_plugins install -v 'PyQt5==5.14.2' 'PyQt5-sip==12.7.2'
Note that the exact name of the AppImage will change depending on which version you install.
Plover does not currently support Wayland (issue #1050). Wayland is used by default in many distributions — you'll need to switch back to X11.
Two AUR packages are provided:
- plover for the latest stable release
- and plover-git for the current
master
Note: the plugins manager is not part of plover-git, and is available as a separate package.
Currently, only a git ebuild for the master branch is provided.
Personal overlay. (out of date dependencies)
Plover is packaged in the Void Linux repositories under the package name plover.
Note: the plugins manager has not been packaged yet.
Initially, Plover is set up to use your computer keyboard as a steno machine. If you have a steno machine, you'll need to configure Plover to look for your machine. Please check the Supported Hardware page to find instructions specific to your machine.
If you want to build from source (e.g. if you are a developer), follow the guide for your operating system: