Installation Guide - Revision history

Aqwek: Removed Wayland incompatability warning and added mentions of the plover and plover-git AUR packages being maintained.

2026-02-26T08:58:42Z

Removed Wayland incompatability warning and added mentions of the plover and plover-git AUR packages being maintained.

← Older revision		Revision as of 08:58, 26 February 2026
Line 49:		Line 49:

	<!--T:11-->		<!--T:11-->
	Plover is provided as an AppImage. This is the only officially supported method to use Plover on Linux.		Plover is provided as an AppImage. This is the only officially supported method to use Plover on Linux. Unofficially, there is the <code>plover</code> and <code>plover-git</code> on the AUR for any Arch-based distros.<span id="download-the-plover-appimage-here"></span>

	<~~!--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 [[Wayland]]~~ for ~~workarounds and other alternatives to Plover~~.}}

	~~<!--T:13-->~~
	<span id="download-the-plover-appimage-here"></span>

	=== [https://github.com/openstenoproject/plover/releases/latest Download the Plover AppImage here (Linux: AppImage)] ===		=== [https://github.com/openstenoproject/plover/releases/latest Download the Plover AppImage here (Linux: AppImage)] ===

Toyboot4e: Add note about Plover installation with Nix

2025-07-13T06:13:47Z

Add note about Plover installation with Nix

← Older revision		Revision as of 06:13, 13 July 2025
Line 8:		Line 8:
	For detailed instructions on installation, use the left navigation bar to jump to the section corresponding to your OS.		For detailed instructions on installation, use the left navigation bar to jump to the section corresponding to your OS.

	== Install Plover on Windows == <!--T:1-->		== Install Plover on Windows (Installer or Portable Zip) == <!--T:1-->

	<!--T:2-->		<!--T:2-->
Line 22:		Line 22:
	<!--T:4-->		<!--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 (Disk Image) ==
	<span id="download-plover-for-mac-here"></span>		<span id="download-plover-for-mac-here"></span>

Line 46:		Line 46:
	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>		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 == <!--T:10-->		== Install Plover on Linux (AppImage) == <!--T:10-->

	<!--T:11-->		<!--T:11-->
Line 108:		Line 108:
	<!--T:26-->		<!--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>~~

	== Setting up your writer == <!--T:27-->		== Setting up your writer == <!--T:27-->
Line 151:		Line 150:

	<!--T:38-->		<!--T:38-->
	Note: the plugins manager has not been packaged yet.<~~span id="troubleshooting"~~></~~span~~>		Note: the plugins manager has not been packaged yet.

			=== Nix (nixpkgs) ===
			If you're using Nix, [https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=plover search for nixpkgs] to get <code>plover</code> or <code>plover-dev</code>.

			'''However, they don't seem to be working right now'''. Try the Nix Flakes in the next section instead.

			=== Nix Flakes ===
			Try [https://github.com/openstenoproject/plover-flake plover-flake] for Plover installation with Nix. See the README for details, or feel free to open issues on GitHub or ask in Discord.

	== Troubleshooting ==		== Troubleshooting ==

Toyboot4e: Typo fix (sorry)

2025-07-13T06:04:35Z

Typo fix (sorry)

← Older revision		Revision as of 06:04, 13 July 2025
Line 13:		Line 13:
	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.		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/latest Download the Windows installer here (Windows: Installer)] ===		=== [Https://github.com/openstenoproject/plover/releases/latest Download the Windows installer here (Windows: Installer)] ===

	<!--T:3-->		<!--T:3-->

Toyboot4e: Avoiding manual URL edit on every release, using latest link

2025-07-13T06:03:50Z

Avoiding manual URL edit on every release, using latest link

← Older revision		Revision as of 06:03, 13 July 2025
Line 12:		Line 12:
	<!--T:2-->		<!--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 if the host machine has restricted permissions. For all other use cases, however, the installer method is recommended.		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/v4.0.1/plover-4.0.1-win64.setup.exe~~ Download the Windows installer here] ===
			=== [./Https://github.com/openstenoproject/plover/releases/latest Download the Windows installer here (Windows: Installer)] ===

	<!--T:3-->		<!--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.1/plover-4.0.1-win64.zip~~ Download the Windows portable ZIP here] ===
			=== [https://github.com/openstenoproject/plover/releases/latest Download the Windows portable ZIP here (Windows: Portable ZIP)] ===

	<!--T:4-->		<!--T:4-->
Line 22:		Line 24:
	== 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.1/plover-4.0.1-macosx_10_13_x86_64.dmg~~ Download Plover for Mac here] ===
			=== [Https://github.com/openstenoproject/plover/releases/latest Download Plover for Mac here (macOS: Disk Image)] ===

	<!--T:5-->		<!--T:5-->
Line 53:		Line 56:
	<!--T:13-->		<!--T:13-->
	<span id="download-the-plover-appimage-here"></span>		<span id="download-the-plover-appimage-here"></span>
	=== [https://github.com/openstenoproject/plover/releases/~~download/v4.0.1/plover-4.0.1-x86_64.AppImage~~ Download the Plover AppImage here] ===
			=== [https://github.com/openstenoproject/plover/releases/latest Download the Plover AppImage here (Linux: AppImage)] ===

	<!--T:14-->		<!--T:14-->

BTackt at 22:32, 22 May 2025

2025-05-22T22:32:48Z

← Older revision		Revision as of 22:32, 22 May 2025
Line 109:		Line 109:

	<!--T:28-->		<!--T:28-->
	~~See: [[~~Setting up your writer with Plover]]		{{Main article\|Setting up your writer with Plover}}

	== Other installation methods ==		== Other installation methods ==

BTackt at 22:14, 22 May 2025

2025-05-22T22:14:00Z

← Older revision		Revision as of 22:14, 22 May 2025
Line 49:		Line 49:

	<!--T:12-->		<!--T:12-->
	{{Warning\|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.}}		{{Warning\|text=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.}}

	<!--T:13-->		<!--T:13-->

BTackt at 22:13, 22 May 2025

2025-05-22T22:13:45Z

← Older revision		Revision as of 22:13, 22 May 2025
Line 37:		Line 37:

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

BTackt: /* Install Plover on Mac */

2025-05-22T22:06:23Z

Install Plover on Mac

← Older revision		Revision as of 22:06, 22 May 2025
Line 37:		Line 37:

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

BTackt at 22:04, 22 May 2025

2025-05-22T22:04:40Z

← Older revision		Revision as of 22:04, 22 May 2025
Line 37:		Line 37:

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

	<!--T:12-->		<!--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 [[Wayland]] for workarounds and other alternatives to Plover.}}		{{Warning\|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.}}

	<!--T:13-->		<!--T:13-->

BTackt: /* Download the Plover AppImage here */ remove underscore in the link

2025-05-09T22:33:36Z

Download the Plover AppImage here: remove underscore in the link

← Older revision		Revision as of 22:33, 9 May 2025
Line 64:		Line 64:
	# 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>

	For more information, read about Plover's [[~~AppImage_integration~~]].		For more information, read about Plover's [[AppImage integration]].

	=== Allow Access to Serial Ports ===<!--T:16-->		=== Allow Access to Serial Ports ===<!--T:16-->