Installation Guide: Difference between revisions

From Plover Wiki
VisualWikitext
mNo edit summary
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Install Plover on Windows =
<languages />
<translate>
== Install Plover on Windows == <!--T:1-->


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>
<!--T:2-->
== [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-win64.setup.exe Download the Windows installer here] ==
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 if the host machine has restricted permissions. For all other use cases, however, the installer method is recommended.
=== [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>
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/v4.0.0rc2/plover-4.0.0rc2-win64.zip Download the Windows portable ZIP here] ==
=== [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>
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 =
== Install Plover on Mac ==
<span id="download-plover-for-mac-here"></span>
<span id="download-plover-for-mac-here"></span>
== [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-macosx_10_13_x86_64.dmg Download Plover for Mac here] ==
=== [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.
# Open the <code>.dmg</code> file.
# In the mounted disk, drag the <code>Plover.app</code> to your <code>Applications</code> folder.
# In the mounted disk, drag the <code>Plover.app</code> to your <code>Applications</code> folder.
# Open the Applications folder, and [https://support.apple.com/en-ca/guide/mac-help/mh40616/mac follow the guide to launch a program from an unidentified developer.]
# Open the Applications folder.
# Open <code>System Preferences &gt; Security &amp; Privacy &gt; Privacy &gt; Accessibility</code>.
# Control-click on Plover, then choose <code>Open</code> from the shortcut menu.
#* When starting Plover for the first time, '''you cannot just double click the app''' (see [https://support.apple.com/en-ca/guide/mac-help/mh40616/mac here] for more info).
# Open <code>System Settings &gt; Privacy & Security &gt; Accessibility</code>.
# Click the <code>+</code> Button, and go to your applications and select <code>Plover.app</code>.
# Click the <code>+</code> Button, and go to your applications and select <code>Plover.app</code>.


<!--T:6-->
Plover is set up! You can run Plover like you would any other application.
Plover is set up! You can run Plover like you would any other application.


<blockquote>'''Note''': Other “keyboard helper”-type applications (e.g. Karabiner Elements and text expanders) may interfere with Plover.
<!--T:8-->
</blockquote><span id="if-you-had-previously-uninstalled-plover-or-upgraded-your-system"></span>
{{Info|text=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 ===
</blockquote><span id="if-you-had-previously-uninstalled-plover-or-upgraded-your-system"></span>}}
==== If you had previously uninstalled Plover or upgraded your system ====


Repeat step 4, 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, read <code>Plover.app</code> by repeating step 5.<span id="install-plover-on-linux"></span>
<!--T:9-->
= Install Plover on Linux =
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>


Plover is provided as an AppImage. This is the only officially supported method to using Plover on Linux.
== Install Plover on Linux == <!--T:10-->


Please note that '''Plover is not officially supported on systems running Wayland at this moment'''. Many distros use Wayland by default and you will need to switch back 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.<span id="download-the-plover-appimage-here"></span>
<!--T:11-->
== [https://github.com/openstenoproject/plover/releases/download/v4.0.0rc2/plover-4.0.0rc2-x86_64.AppImage Download the Plover AppImage here] ==
Plover is provided as an AppImage. This is the only officially supported method to use Plover on Linux.


<!--T:12-->
{{Warning|text=Plover is not officially supported on systems running Wayland (such as Ubuntu and Fedora by default). See the wiki page on [https://plover.wiki/index.php/Wayland Wayland] for workarounds and other alternatives to Plover.}}
<!--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:
To use it:


<!--T:15-->
# Download it
# Download it
# [http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80 Make it executable]
# [http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80 Make it executable]
# Launch it like a standard executable<span id="allow-access-to-serial-ports"></span>
# Launch it like a standard executable<span id="allow-access-to-serial-ports"></span>
== Allow Access to Serial Ports ==


All hobbyist steno keyboards by default use serial protocols to communicate with Plover. You will have to give your user the right privileges in order for these keyboards to work with Plover. You can do this by adding your user to the relevant group.
=== 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:
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>
<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.
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:
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>
<pre>sudo usermod -aG &lt;group&gt; $USER</pre>
Replace <code>&lt;group&gt;</code> with the output of the previous command.
Replace <code>&lt;group&gt;</code> with the output of the previous command.


'''Once you have added yourself to the right group, restart your computer.'''<span id="error-relating-to-xcb"></span>
<!--T:21-->
== Error relating to xcb ==
'''Once you have added yourself to the right group, log out and log back in, or restart your computer (recommended).'''


=== Error relating to xcb ===<!--T:22-->
You may run into the following error when trying to run Plover:
You may run into the following error when trying to run Plover:


<blockquote>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.
<!--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>
</blockquote>
Ensure that the following packages are installed:
Ensure that the following packages are installed:


<!--T:24-->
* <code>libxcb</code>
* <code>libxcb</code>
* <code>xcb-util</code>
* <code>xcb-util</code>
Line 65: Line 91:
* <code>libxcb-cursor0</code>
* <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:
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>
<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>
<span id="setting-up-my-machine"></span>
= 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 [https://github.com/openstenoproject/plover/wiki/Supported-Hardware Supported Hardware page] to find instructions specific to your machine.<span id="other-installation-methods"></span>
== Setting up your writer == <!--T:27-->
= Other installation methods =
 
<!--T:28-->
See: [[Setting up your writer with Plover]]
 
== Other installation methods ==
<span id="other-releases"></span>
<span id="other-releases"></span>
== Other releases ==
=== 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.]]


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.<span id="homebrew-cask"></span>
=== Homebrew Cask === <!--T:30-->
== Homebrew Cask ==


<!--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>
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 ==
=== Arch AUR package ===


<!--T:32-->
Two AUR packages are provided:
Two AUR packages are provided:


<!--T:33-->
# [https://aur.archlinux.org/packages/plover/ plover] for the latest stable release
# [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>
# 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>
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 ==
=== Gentoo git ebuild ===


<!--T:35-->
Currently, only a git ebuild for the <code>master</code> branch is provided.
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>
[https://framagit.org/3/ebuilds Personal overlay.] (out of date dependencies)<span id="void-linux-package"></span>
== Void Linux package ==
== Void Linux package ==


<!--T:37-->
Plover is packaged in the Void Linux repositories under the package name <code>plover</code>.
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>
Note: the plugins manager has not been packaged yet.<span id="troubleshooting"></span>
= Troubleshooting =
== Troubleshooting ==


<!--T:39-->
If you get stuck, you can:
If you get stuck, you can:


<!--T:40-->
* Check the [[Troubleshooting Issues|troubleshooting guide.]]
* 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.]
* 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.]
* 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.]


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>
<!--T:41-->
= For developers: running from source =
We also have a [https://discord.gg/0lQde43a6dGmAMp2 Plover Discord Server], the [[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:
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/windows <code>plover/windows</code>]
* [https://github.com/openstenoproject/plover/tree/master/linux <code>plover/linux</code>]
* [https://github.com/openstenoproject/plover/tree/master/linux <code>plover/linux</code>]
Line 116: Line 163:




<!--T:44-->
[[Category:Plover]]
[[Category:Plover]]
</translate>

Latest revision as of 21:58, 26 June 2024

Other languages:

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 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

  1. Open the .dmg file.
  2. In the mounted disk, drag the Plover.app to your Applications folder.
  3. Open the Applications folder.
  4. Control-click on Plover, then choose Open from the shortcut menu.
    • When starting Plover for the first time, you cannot just double click the app (see here for more info).
  5. Open System Settings > Privacy & Security > Accessibility.
  6. Click the + Button, and go to your applications and select Plover.app.

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

format=frameless
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 use Plover on Linux.

format=frameless
format=frameless

Plover is not officially supported on systems running Wayland (such as Ubuntu and Fedora by default). See the wiki page on Wayland for workarounds and other alternatives to Plover.

Download the Plover AppImage here

To use it:

  1. Download it
  2. Make it executable
  3. 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, log out and log back in, or restart your computer (recommended).

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 your writer

See: Setting up your writer with Plover

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:

  1. plover for the latest stable release
  2. 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:

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:

Retrieved from "https://plover.wiki/index.php?title=Installation_Guide&oldid=2299"