Installing Dolphin: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(openSUSE instructions)
(21 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 [http://dolphin-emu.org/docs/faq/ FAQ] for more Dolphin information and requirements.
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, and you're good.
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.
*Dolphin for Windows now use [[Controlling the Global User Directory|Global User Directory]]. By default, it is under <var>%userprofile%\Documents\Dolphin Emulator\</var>. You do not need to migrate anything if the previous Dolphin build was {{revision|3.5-2381}} or higher. Otherwise, you may want to migrate every folders beside <var>\Languages\</var> and <var>\Sys\</var> to there. And if one migrated folder happens to be <var>\User\</var> then move all subfolders one level up from that folder.
*The older save states may not work between versions.


== 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
=== Arch Linux ===
Install: <code># pacman -S dolphin-emu</code>
See also the [https://aur.archlinux.org/packages/?O=0&K=dolphin-emu AUR] and read more on the [https://wiki.archlinux.org/index.php/Dolphin_emulator ArchWiki].
=== Debian ===
Dolphin is available in the repositories of the "testing" and "sid" branches of Debian, for AMD64 and ARM64 platforms.
'''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 dolphin-emu</code>
See further package information on the [https://packages.debian.org/search?suite=all&section=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 ===
=== Ubuntu ===
Ubuntu users can add a '''PPA''' by executing the following commands to receive updates for Dolphin ([http://askubuntu.com/questions/148638/how-do-i-enable-the-universe-repository '''Universe''' repository] is needed to be enabled first).
Ubuntu users can add a '''PPA''' by executing the following commands to receive updates for Dolphin ([https://askubuntu.com/questions/148638/how-do-i-enable-the-universe-repository '''Universe''' repository] is needed to be enabled first).


This applies to '''all''' [http://distrowatch.com/search.php?basedon=Ubuntu Ubuntu-based distributions].
This applies to '''all''' [https://distrowatch.com/search.php?basedon=Ubuntu Ubuntu-based distributions].


Install the '''stable version''':
Install the '''stable version''':


<pre>sudo apt-add-repository ppa:dolphin-emu/ppa
<pre>sudo apt-add-repository ppa:dolphin-emu/ppa
sudo apt-get update
sudo apt update
sudo apt-get install dolphin-emu</pre>
sudo apt install dolphin-emu</pre>


Or to install the '''development version''':
Or to install the '''development version''':


<pre>sudo apt-add-repository ppa:dolphin-emu/ppa
<pre>sudo apt-add-repository ppa:dolphin-emu/ppa
sudo apt-get update
sudo apt update
sudo apt-get install dolphin-emu-master</pre>
sudo apt install dolphin-emu-master</pre>


'''NOTICE''': '''12.04''' and '''14.04''' users will need an updated '''libstdc++6''' (>=4.9) to run dolphin-emu or dolphin-emu-master, so install [https://launchpad.net/~ubuntu-toolchain-r/+archive/ubuntu/test this PPA] first:
'''NOTICE''': '''14.04 LTS''' users will need an updated '''libstdc++6''' (>=4.9) to run dolphin-emu or dolphin-emu-master, so install [https://launchpad.net/~ubuntu-toolchain-r/+archive/ubuntu/test this PPA] first:


<pre>
<pre>
sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-add-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt update
</pre>
</pre>


You don't need to update all GCC packages, just upgrade libstdc++6, gcc-4.9-base and eventual dependencies in Synaptic, and disable the PPA.
You don't need to update all GCC packages, just upgrade libstdc++6, gcc-4.9-base and eventual dependencies in Synaptic, and disable the PPA.


=== Arch Linux ===
=== Fedora ===
Install: <code># pacman -S dolphin-emu</code>
On Fedora 24 and later, run the following command:


See also the [https://aur.archlinux.org/packages/?O=0&K=dolphin-emu AUR] and read more on the [https://wiki.archlinux.org/index.php/Dolphin_emulator ArchWiki].
<code># dnf install dolphin-emu</code>


=== Debian ===
Required dependencies will automatically be installed. See also the [https://admin.fedoraproject.org/pkgdb/package/rpms/dolphin-emu/ Fedora Package Database].
Dolphin is available in the repositories of the "stretch" and "sid" branches of Debian.
'''NOTICE''': Users of Jessie or any earlier versions MUST build from source as per the instructions linked below in "Other Distros"!
 
Install: <code># apt-get install dolphin-emu</code>
 
See further package information on the [https://packages.debian.org/search?suite=all&section=all&arch=any&searchon=names&keywords=dolphin-emu Debian Package Info page].


=== Other Distros ===
=== Other Distros ===

Revision as of 23:27, 1 April 2018

This page explains how to install or upgrade Dolphin on computer running on different OS. Read the 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.

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 Download page and extract it into a new folder (preferably named after the revision) or to replace an existing Dolphin setup.

Linux

Ready to use packages for a range of Linux distributions are available from Open Build Service: https://software.opensuse.org/package/dolphin-emu

Arch Linux

Install: # pacman -S dolphin-emu

See also the AUR and read more on the ArchWiki.

Debian

Dolphin is available in the repositories of the "testing" and "sid" branches of Debian, for AMD64 and ARM64 platforms. NOTICE: Users of Jessie or any earlier versions MUST build from source as per the instructions linked below in "Other Distros"!

Install: # apt install dolphin-emu

See further package information on the Debian Package Info page.

openSUSE Linux

Install from the software page for dolphin-emu, or use the following code:

zypper ar http://download.opensuse.org/repositories/Emulators/openSUSE_Tumbleweed/Emulators.repo
zypper ref
zypper in dolphin-emu

Ubuntu

Ubuntu users can add a PPA by executing the following commands to receive updates for Dolphin (Universe repository is needed to be enabled first).

This applies to all Ubuntu-based distributions.

Install the stable version:

sudo apt-add-repository ppa:dolphin-emu/ppa
sudo apt update
sudo apt install dolphin-emu

Or to install the development version:

sudo apt-add-repository ppa:dolphin-emu/ppa
sudo apt update
sudo apt install dolphin-emu-master

NOTICE: 14.04 LTS users will need an updated libstdc++6 (>=4.9) to run dolphin-emu or dolphin-emu-master, so install this PPA first:

sudo apt-add-repository ppa:ubuntu-toolchain-r/test
sudo apt update

You don't need to update all GCC packages, just upgrade libstdc++6, gcc-4.9-base and eventual dependencies in Synaptic, and disable the PPA.

Fedora

On Fedora 24 and later, run the following command:

# dnf install dolphin-emu

Required dependencies will automatically be installed. See also the Fedora Package Database.

Other Distros

Other GNU/Linux users have to build and install from source code.

Post-Installation Quick Guide

In most cases, the default settings works fine, but Configuring Controllers is the first part that comes into mind that is more than likely needed to be configured.

See Ripping Games to learn how to rip games and saves to your new Dolphin set up. For complete Wii NAND dump to use on Dolphin, see NAND Usage Guide. The homebrew apps are freely available over the internet and can be added to the game list at any time.

Browsing Files

You can simply launch a compatible file by hitting File > Open... then open a file. To add a game to the game list, select Files > Browse for ISOs... then select a folder to be added to the game list.

Banners for Wii games will not load at first. Making a save file for that game fixes it. This is a limitation with the format of Wii games rather than a bug.

Compatible Files by File Extension

File extension Platform Notes
.ISO GameCube and Wii Generic file extension for disc image files.
.GCM GameCube This file extension is interchangeable with .ISO.
.GCZ GameCube and Wii Compressed GameCube/Wii disc image file.
.WBFS Wii "Wii Backup File System", compressed Wii disc image file.
.WAD Virtual Console and WiiWare
.DOL, .ELF Homebrew app

Managing Game List

You can also batch add/remove titles in the game list by creating folders that group each titles by platform (this is to keep game directories well organized), then go to Options > Configure... > "Paths" tab > then hit Add... then enable Search SubFolders within the "Paths" config, then add these folders to the ISO Directories list.