3,800
edits
Progress Continues
We've already had 21687 updates since Dolphin 5.0. Keep up with Dolphin's continuing progress through the Dolphin Blog: February, March, and April 2024 Dolphin Progress Report. |
The Dolphin Emulator Wiki needs your help! Dolphin can play thousands of games, and changes are happening all the time. Help us keep up! Join in and help us make this the best resource for Dolphin. |
(→Linux) |
(Added an Android section too while I was at it.) |
||
(26 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
This page explains how to install or upgrade Dolphin on computer running on different OS. Read the [ | This page explains how to install or upgrade Dolphin on computer running on different OS. Read the [https://dolphin-emu.org/docs/faq/ FAQ] for more Dolphin information and requirements. | ||
== Profile-breaking Notices == | |||
Please check these before updating your Dolphin setup to avoid the Dolphin profile incompatibilities between versions, with the exception of performing the first time Dolphin setup. | |||
* Older save states may not work between versions. Be sure to save your game progress the normal way in-game before updating. | |||
* Since {{revision|3.5-2381}}, Dolphin for Windows now uses the [[Controlling the Global User Directory|Global User Directory]]. | |||
* GameINI: Since {{revision|4.0-8581}}, <code>FrameLimit = 0x00000001</code> superseded by <code>EmulationSpeed = 1.00000000</code>. View the all-new values at [[GameINI#Emulation Speed (formerly Framelimit)]] | |||
== Windows and Mac == | == Windows and Mac == | ||
Installing or upgrading process for Dolphin on Windows PC or Mac is pretty simple. Download the latest revision or version from the [https://dolphin-emu.org/download/ Download] page and extract it into a new folder (preferably named after the revision) or to replace an existing Dolphin setup | Installing or upgrading process for Dolphin on Windows PC or Mac is pretty simple. Download the latest revision or version from the [https://dolphin-emu.org/download/ Download] page and extract it into a new folder (preferably named after the revision) or to replace an existing Dolphin setup. | ||
=== macOS Security Restrictions === | |||
When downloading Dolphin for the first time, you may experience crashes or the Dolphin Updater will fail. | |||
This may be caused by Gatekeeper, because it moved Dolphin to a "quarantined" location for security. See {{issue|12105}}. | |||
This issue is fixed by {{Revision|5.0-14529}}. | |||
Before this revision, a temporary fix is to run two commands into Terminal: | |||
<pre> | |||
sudo xattr -r -d com.apple.quarantine /path/to/Dolphin.app | |||
sudo xattr -r -d com.apple.quarantine /path/to/Dolphin\ Updater.app | |||
</pre> | |||
== Linux == | == Linux == | ||
Ready to use packages for a range of Linux distributions are available from Open Build Service: https://software.opensuse.org/package/dolphin-emu | Ready to use packages for a range of Linux distributions are available from Open Build Service: https://software.opensuse.org/package/dolphin-emu | ||
Line 19: | Line 34: | ||
'''NOTICE''': Users of Jessie or any earlier versions MUST build from source as per the instructions linked below in "Other Distros"! | '''NOTICE''': Users of Jessie or any earlier versions MUST build from source as per the instructions linked below in "Other Distros"! | ||
Install: <code># apt | Install: <code># sudo apt install dolphin-emu</code> | ||
See further package information on the [https://packages.debian.org/search?suite=all§ion=all&arch=any&searchon=names&keywords=dolphin-emu Debian Package Info page]. | See further package information on the [https://packages.debian.org/search?suite=all§ion=all&arch=any&searchon=names&keywords=dolphin-emu Debian Package Info page]. | ||
=== | === openSUSE Linux === | ||
Install from the [http://software.opensuse.org/package/dolphin-emu software page for dolphin-emu], or use the following code: | |||
<pre>zypper ar http://download.opensuse.org/repositories/Emulators/openSUSE_Tumbleweed/Emulators.repo | |||
zypper ref | |||
zypper in dolphin-emu | |||
</pre> | |||
===Ubuntu=== | |||
As of 18.04LTS, possibly some time prior, Dolphin is available in Ubuntu's own package repository, so if Ubuntu's Universe repositories have been enabled first, users can run <code>sudo apt install dolphin-emu</code>. | |||
The Universe repositories provide versions of Dolphin for amd64 (a.k.a. x64 or 64-bit) and arm64 (a.k.a. ARMv8-A). | |||
[https://launchpad.net/ubuntu/+source/dolphin-emu Ubuntu Launchpad] and [https://packages.ubuntu.com/search?keywords=dolphin-emu&searchon=names&suite=all§ion=all Ubuntu's package search] as of 28 February 2024, lists Dolphin versions (though not necessarily recent Dolphin updates) for 14.04 LTS, 16.04 LTS, 18.04 LTS, and 20.04 LTS, but claims to only supports 23.04 and 23.10 among stable Ubuntu versions. | |||
====Older Ubuntu versions==== | |||
At one point, Dolphin had its own Ubuntu PPA (which also applied to all Ubuntu-based distributions) that could be added to the ''apt'' fetch list with <code>sudo apt-add-repository ppa:dolphin-emu/ppa</code>, whose PPA also offered <code>sudo apt install dolphin-emu-master</code>. | |||
However, the PPA is no longer active as of 28 February 2024. | |||
=== Fedora === | === Fedora === | ||
On Fedora 24 and later, run the following command: | |||
<code># dnf install dolphin-emu</code> | |||
Required dependencies will automatically be installed. See also the [https://admin.fedoraproject.org/pkgdb/package/rpms/dolphin-emu/ Fedora Package Database]. | Required dependencies will automatically be installed. See also the [https://admin.fedoraproject.org/pkgdb/package/rpms/dolphin-emu/ Fedora Package Database]. | ||
=== Windows Subsystem for Linux 2 === | |||
The above guides for specific distros apply. However, WSL2 does not natively include a Linux desktop environment nor X11/Wayland as of 16 March 2024, and relies on spotty VNC implementations (whether built-in or third-party), so installing Dolphin in WSL2 requires advanced Linux expertise. | |||
=== Other Distros === | === Other Distros === | ||
*[https://flathub.org/apps/org.DolphinEmu.dolphin-emu Dolphin on Flathub]. | |||
*[https://snapcraft.io/dolphin-emulator Dolphin on Snap Store] (amd64 only as of 28 February 2024). | |||
Other GNU/Linux users have to [[Building Dolphin on Linux|build and install from source code]]. | Other GNU/Linux users have to [[Building Dolphin on Linux|build and install from source code]]. | ||
==Android== | |||
Provided as a standard installable APK, available from Dolphin's download pages, from [https://play.google.com/store/apps/details?id=org.dolphinemu.dolphinemu Google Play Store], and from [https://f-droid.org/packages/org.dolphinemu.dolphinemu/ F-Droid]. | |||
As of 16 March 2024, the APK natively supports both ARM64-v8A and amd64; older devices that depend on ARMv7 (ARM 32-bit) will not be able to run Dolphin. | |||
Devices need to support OpenGL buffer storage to run Dolphin in a playable state. This excludes ''Windows Subsystem for Android'' as of 16 March 2024, among others. | |||
== Post-Installation Quick Guide == | == Post-Installation Quick Guide == | ||
Line 91: | Line 113: | ||
| Wii | | Wii | ||
| "Wii Backup File System", compressed Wii disc image file. | | "Wii Backup File System", compressed Wii disc image file. | ||
|- | |||
| <var>.WIA</var> | |||
| Wii | |||
| "Wii ISO Archive", compressed or uncompressed Wii disc image file. Available since {{revision|5.0-12188}}. | |||
|- | |||
| <var>.RVZ</var> | |||
| Gamecube and Wii | |||
| Compressed GameCube/Wii disc image file. This specifically works in Dolphin. Available since {{revision|5.0-12188}}. | |||
|- | |- | ||
| <var>.WAD</var> | | <var>.WAD</var> |