Installation Guide: Difference between revisions

Revision as of 15:23, 25 February 2024

Install Plover on Windows

Plover can be installed or ran as a portable ZIP. It may be useful to use the portable ZIP if you are running Plover off of a USB stick or the if the host machine has restricted permissions. For all other use cases, however, the installer method is recommended.

Download the Windows installer here

Run the installer and follow the onscreen instructions. You may need to grant permissions for the app to bypass Windows Defender SmartScreen.

Download the Windows portable ZIP here

Extract the entire folder to the location that you’d like to run Plover from. Inside the folder, run plover.exe to start Plover.

Install Plover on Mac

Download Plover for Mac here

Open the .dmg file.
In the mounted disk, drag the Plover.app to your Applications folder.
Open the Applications folder.
Control-click on Plover, then choose Open from the shortcut menu.
Open System Settings > Privacy & Security > Accessibility.
Click the + Button, and go to your applications and select Plover.app.

format=frameless

Make sure to follow step 4 when starting Plover for the first time. Double clicking the app will not work if it is your first time opening Plover (see here for more info).

Plover is set up! You can run Plover like you would any other application.

format=frameless

Other “keyboard helper”-type applications (e.g. Karabiner Elements and text expanders) may interfere with Plover.

If you had previously uninstalled Plover or upgraded your system

Repeat step 5, and remove Plover from the list. Do not just uncheck Plover; you will have to explicitly remove Plover by using the - button. Once Plover has been removed, re-add Plover.app by repeating step 6.

Install Plover on Linux

Plover is provided as an AppImage. This is the only officially supported method to using Plover on Linux.

format=frameless

Plover is not officially supported on systems running Wayland at this moment. Many distros use Wayland by default and you will need to switch to X11 in order to use Plover. Follow a tutorial like this one to determine if you’re running Wayland and how to switch.

Download the Plover AppImage here

To use it:

Download it
Make it executable
Launch it like a standard executable

Allow Access to Serial Ports

All hobbyist steno keyboards use serial protocols to communicate with Plover. Users by default do not have privileges to use these protocols. You will have to add your user to a group in order to obtain those privileges.

To find the name of the relevant group, plug in your steno keyboard and open a terminal to run the following command:

stat -c "%G" /dev/ttyACM*

You should see dialout or uucp depending on your distro. If the above command results in a “file not found” error, try replacing ACM with USB and verify that your keyboard is connected with a working cable.

Once you know the correct group, add your user to it by running the following command:

sudo usermod -aG <group> $USER

Replace <group> with the output of the previous command.

Once you have added yourself to the right group, restart your computer.

Error relating to xcb

You may run into the following error when trying to run Plover:

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 the following packages are installed:

libxcb
xcb-util
qt5-qtstyleplugins
libxcb-cursor0

Note that the names of these packages may differ depending on the distro you are using. If the error still persists, run the following:

./plover-4.0.0rc2-x86_64.AppImage -s plover_plugins install -v 'PyQt5==5.14.2' 'PyQt5-sip==12.7.2'

Setting up my machine

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.

Other installation methods

Other releases

You can browse various other releases of Plover by scrolling through the releases page. To download a release, click on “Assets” and download the applicable file for your operating system.

downloading other versions gif — Scroll down and click "Assets" in order to find the download links. You don't have to download every file; only the one that is applicable to your operating system.

Homebrew Cask

If you have Homebrew Cask installed on your system, you can run brew install --cask plover at the command-line.

Arch AUR package

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.

Gentoo git ebuild

Currently, only a git ebuild for the master branch is provided.

Personal overlay. (out of date dependencies)

Void Linux package

Plover is packaged in the Void Linux repositories under the package name plover.

Note: the plugins manager has not been packaged yet.

Troubleshooting

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.

For developers: running from source

If you want to build from source (e.g. if you are a developer), follow the guide for your operating system:

@@ Line 1: / Line 1: @@
 <languages />
 <translate>
-== Install Plover on Windows ==
+== Install Plover on Windows == <!--T:1-->
+<!--T:2-->
 Plover can be installed or ran as a portable ZIP. It may be useful to use the portable ZIP if you are running Plover off of a USB stick or the if the host machine has restricted permissions. For all other use cases, however, the installer method is recommended.<span id="download-the-windows-installer-here"></span>
 === [https://github.com/openstenoproject/plover/releases/download/continuous/plover-4.0.0rc2+6.g53c416f-win64.setup.exe Download the Windows installer here] ===
+<!--T:3-->
 Run the installer and follow the onscreen instructions. You may need to [https://www.windowscentral.com/how-disable-smartscreen-trusted-app-windows-10 grant permissions for the app to bypass Windows Defender SmartScreen.]<span id="download-the-windows-portable-zip-here"></span>
 === [https://github.com/openstenoproject/plover/releases/download/continuous/plover-4.0.0rc2+6.g53c416f-win64.zip Download the Windows portable ZIP here] ===
+<!--T:4-->
 Extract the entire folder to the location that you’d like to run Plover from. Inside the folder, run <code>plover.exe</code> to start Plover.<span id="install-plover-on-mac"></span>
 == Install Plover on Mac ==
@@ Line 14: / Line 17: @@
 === [https://github.com/openstenoproject/plover/releases/download/continuous/plover-4.0.0rc2+6.g53c416f-macosx_10_13_x86_64.dmg Download Plover for Mac here] ===
+<!--T:5-->
 # Open the <code>.dmg</code> file.
 # In the mounted disk, drag the <code>Plover.app</code> to your <code>Applications</code> folder.
@@ Line 21: / Line 25: @@
 # Click the <code>+</code> Button, and go to your applications and select <code>Plover.app</code>.
+<!--T:6-->
 {{Info|text=Make sure to follow step 4 when starting Plover for the first time. '''Double clicking the app will not work''' if it is your first time opening Plover (see [https://support.apple.com/en-ca/guide/mac-help/mh40616/mac here] for more info).}}
+<!--T:7-->
 Plover is set up! You can run Plover like you would any other application.
+<!--T:8-->
 {{Info|text=Other “keyboard helper”-type applications (e.g. Karabiner Elements and text expanders) may interfere with Plover.
 </blockquote><span id="if-you-had-previously-uninstalled-plover-or-upgraded-your-system"></span>}}
 ==== If you had previously uninstalled Plover or upgraded your system ====
+<!--T:9-->
 Repeat step 5, and remove Plover from the list. '''Do not just uncheck Plover; you will have to explicitly remove Plover by using the <code>-</code> button'''. Once Plover has been removed, re-add <code>Plover.app</code> by repeating step 6.<span id="install-plover-on-linux"></span>
-== Install Plover on Linux ==
+== Install Plover on Linux == <!--T:10-->
+<!--T:11-->
 Plover is provided as an AppImage. This is the only officially supported method to using Plover on Linux.
+<!--T:12-->
 {{Info|text='''Plover is not officially supported on systems running Wayland at this moment'''. Many distros use Wayland by default and you will need to switch to X11 in order to use Plover. Follow a tutorial like [https://helpdesk.psionline.com/hc/en-gb/articles/13470827149332-How-to-perform-the-switch-from-the-Wayland-display-server-to-Xorg-X11-on-Linux-Ubuntu-22-04-LTS this one] to determine if you’re running Wayland and how to switch.}}
+<!--T:13-->
 <span id="download-the-plover-appimage-here"></span>
 === [https://github.com/openstenoproject/plover/releases/download/continuous/plover-4.0.0rc2+6.g53c416f-x86_64.AppImage Download the Plover AppImage here] ===
+<!--T:14-->
 To use it:
+<!--T:15-->
 # Download it
 # [http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80 Make it executable]
@@ Line 47: / Line 60: @@
 == Allow Access to Serial Ports ==
+<!--T:16-->
 All hobbyist steno keyboards use serial protocols to communicate with Plover. Users by default do not have privileges to use these protocols. You will have to add your user to a group in order to obtain those privileges.
+<!--T:17-->
 To find the name of the relevant group, plug in your steno keyboard and open a terminal to run the following command:
+<!--T:18-->
 <pre>stat -c &quot;%G&quot; /dev/ttyACM*</pre>
 You should see <code>dialout</code> or <code>uucp</code> depending on your distro. If the above command results in a “file not found” error, try replacing <code>ACM</code> with <code>USB</code> and verify that your keyboard is connected with a working cable.
+<!--T:19-->
 Once you know the correct group, add your user to it by running the following command:
+<!--T:20-->
 <pre>sudo usermod -aG &lt;group&gt; $USER</pre>
 Replace <code>&lt;group&gt;</code> with the output of the previous command.
+<!--T:21-->
 '''Once you have added yourself to the right group, restart your computer.'''<span id="error-relating-to-xcb"></span>
 === Error relating to xcb ===
+<!--T:22-->
 You may run into the following error when trying to run Plover:
+<!--T:23-->
 <blockquote><code>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.</code>
 </blockquote>
 Ensure that the following packages are installed:
+<!--T:24-->
 * <code>libxcb</code>
 * <code>xcb-util</code>
@@ Line 73: / Line 95: @@
 * <code>libxcb-cursor0</code>
+<!--T:25-->
 Note that the names of these packages may differ depending on the distro you are using. If the error still persists, run the following:
+<!--T:26-->
 <pre>./plover-4.0.0rc2-x86_64.AppImage -s plover_plugins install -v 'PyQt5==5.14.2' 'PyQt5-sip==12.7.2'</pre>
 <span id="setting-up-my-machine"></span>
-== Setting up my machine ==
+== Setting up my machine == <!--T:27-->
+<!--T:28-->
 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 [https://github.com/openstenoproject/plover/wiki/Supported-Hardware Supported Hardware page] to find instructions specific to your machine.<span id="other-installation-methods"></span>
 == Other installation methods ==
@@ Line 85: / Line 110: @@
 === Other releases ===
+<!--T:29-->
 You can browse various other releases of Plover by scrolling through the [https://github.com/openstenoproject/plover/releases releases page]. To download a release, click on “Assets” and download the applicable file for your operating system.
 [[File:Downloading-other-versions-gif.gif|alt=downloading other versions gif|none|thumb|800x800px|Scroll down and click "Assets" in order to find the download links. You don't have to download every file; only the one that is applicable to your operating system.]]
-=== Homebrew Cask ===
+=== Homebrew Cask === <!--T:30-->
+<!--T:31-->
 If you have [https://caskroom.github.io/ '''Homebrew Cask'''] installed on your system, you can run <code>brew install --cask plover</code> at the command-line.<span id="arch-aur-package"></span>
 === Arch AUR package ===
+<!--T:32-->
 Two AUR packages are provided:
+<!--T:33-->
 # [https://aur.archlinux.org/packages/plover/ plover] for the latest stable release
 # and [https://aur.archlinux.org/packages/plover-git/ plover-git] for the current <code>master</code>
+<!--T:34-->
 Note: the plugins manager is not part of <code>plover-git</code>, and is available as a [https://aur.archlinux.org/packages/plover_plugins_manager/ separate package].<span id="gentoo-git-ebuild"></span>
 === Gentoo git ebuild ===
+<!--T:35-->
 Currently, only a git ebuild for the <code>master</code> branch is provided.
+<!--T:36-->
 [https://framagit.org/3/ebuilds Personal overlay.] (out of date dependencies)<span id="void-linux-package"></span>
 == Void Linux package ==
+<!--T:37-->
 Plover is packaged in the Void Linux repositories under the package name <code>plover</code>.
+<!--T:38-->
 Note: the plugins manager has not been packaged yet.<span id="troubleshooting"></span>
 == Troubleshooting ==
+<!--T:39-->
 If you get stuck, you can:
+<!--T:40-->
 * Check the [[Troubleshooting Issues|troubleshooting guide.]]
 * Search for your problem in our [https://github.com/openstenoproject/plover/issues issue tracker] and our [https://github.com/openstenoproject/plover/discussions Discussions forum.]
 * If you can’t find your particular problem, [https://github.com/openstenoproject/plover/issues/new/choose open a support request] or [https://github.com/openstenoproject/plover/discussions/new start a Discussion.]
+<!--T:41-->
 We also have a [https://discord.gg/0lQde43a6dGmAMp2 Plover Discord Server], the [https://github.com/openstenoproject/plover/wiki/Links-to-the-Steno-Community steno community], and a [https://github.com/openstenoproject/plover/discussions GitHub Discussions forum] if you have a general idea or discussion topic.<span id="for-developers-running-from-source"></span>
 == For developers: running from source ==
+<!--T:42-->
 If you want to build from source (e.g. if you are a developer), follow the guide for your operating system:
+<!--T:43-->
 * [https://github.com/openstenoproject/plover/tree/master/windows <code>plover/windows</code>]
 * [https://github.com/openstenoproject/plover/tree/master/linux <code>plover/linux</code>]
@@ Line 127: / Line 166: @@
+<!--T:44-->
 [[Category:Plover]]
 </translate>