Difference between revisions of "Dolphin"

	Dolphin
General
Author(s)	Contributors (GitHub)
Type	PC utility
License	GPLv2+ (since 2015)
Links
	Download
	Website
	Source

Latest revision as of 07:22, 8 July 2022

Dolphin emulates the Wii and GameCube consoles, as well as various accessories for and derivatives of said consoles. It runs Wii and GameCube software with a x86_64 JIT (Windows, Linux, FreeBSD, macOS) and AArch64 (Android). On June 2008, Dolphin's source was released under the GPLv2 license and is currently under active development.

Obtaining a build

Recommended builds

dolphin-emu.org provides a buildbot for Windows and OS X builds from Git and a FAQ to help users.

Building from source

Follow the instructions to build under Windows, Linux or macOS. Windows and macOS users can use the buildbot to avoid compiling their own source code, but Linux users have to build it themselves in order to use Dolphin.

Usage with Homebrew

From the menu, File -> Open.... Select the elf or dol file you would like to run.

Note that you can cause the screen to be rendered to the main Dolphin window with the Graphics → Render to main window option.

General Notes / Disclaimer

Dolphin is useful to homebrew as it allows developers to test code on a PC before running it on real hardware. However, Dolphin does not support all the features of the Wii and some problems may be experienced running homebrew.
You may want to enable the MMU for more accurate emulation.
Dolphin hooks the typical printf functions when it is able to determine their location. If you are running an elf file (with symbols), and cannot see your debug output, this is could be the reason. Either strip your elf, run the dol, or modify dolphin so this HLE does not take place. The other reason could be that you are writing directly to the XFB (libogc's console output does this). In this case, you additionally need to enable the Graphics->Hacks->External Frame Buffer setting and check Real.
Homebrew applications may hang while initialising sound, i.e. on calling ASND_Init(). A work around would be to skip sound initialisation, so no sound, but there's no need to remove other sound calls in your code. Using the DSP LLE audio backend will improve sound accuracy, and may help avoid hangs.
You can find an SD Card image in something like User\Documents\Wii\sd.raw, kept in the Dolphin folder. If missing it may create it on the first run, you can add things to the sd.raw image with a tool such as winimage. On Linux, it can be simply mounted directly.
When using code that makes use of the SD Card make sure you use the full path name i.e. (sd:/apps/MyApp/gfxfiles/Image.png); using a relative path (/gfxfiles/Image.png) will not work as your application is launching from an unknown location.
When not using libogc, Dolphin may run the app in GameCube mode. This can be fixed by inserting the u32 0x7c13fba6 in a text segment. This instruction does not need to run, but it needs to be in a place that causes it to exist in the binary.

Compatibility

Note: This section is pretty outdated

The following was tested with examples from devkitPro svn r4455, running on Windows 7 (64bit), Dolphin svn r6430. Apps run with default settings unless noted otherwise. These results are provided so that one can quickly realize which options are needed for common tasks - such as using SD support, homebrew text console, etc.

Title	Notes
examples\wii\audio\*	Work acceptably. Requires DSP LLE plugin to be used. Audio may have artifacts.
examples\wii\devices\network\sockettest	Does not work. Socket is not setup successfully.
examples\wii\devices\usbgecko\gdbstub	Works correctly. Requires USBGecko device selected. Sets up a TCP server to accept connections (instead of a serial device). The TCP port used will be displayed on-screen when dolphin begins emulation.
examples\wii\devices\usbkeyboard\basic_stdin	Works correctly. Requires Graphics->Hacks->External Frame Buffer->Real to be checked. Requires Config->Wii->Connect USB Keyboard to be enabled.
examples\wii\filesystem\directory	Works correctly. Requires Graphics->Hacks->External Frame Buffer->Real to be checked. Requires Config->Wii->Insert SD Card to be enabled.
examples\wii\graphics\gx\gxSprites	Works correctly.
examples\wii\graphics\gx\neheGX\lesson1-7	Work correctly.
examples\wii\graphics\gx\neheGX\lesson8	Texturing is broken.
examples\wii\graphics\gx\triangle	Works correctly.
examples\wii\template	Works correctly. Requires Graphics->Hacks->External Frame Buffer->Real to be checked.

Screenshot

Running NeHe lesson5
Dolphin main window and About window

@@ Line 1: / Line 1: @@
 {{Infobox homebrew
-| image = [[File:Dolphin_logo.png|200px]]
+| image = [[File:Dolphin-logo.svg|200px]]
 | title = Dolphin
 | type = pc utility
-| author = [http://code.google.com/p/dolphin-emu/people/list GoogleCode Contributors]
+| author = [https://github.com/dolphin-emu/dolphin/graphs/contributors Contributors (GitHub)]
-| website = http://www.dolphin-emu.com/
+| website = https://dolphin-emu.org
-| source = http://code.google.com/p/dolphin-emu/source/checkout
+| source = https://github.com/dolphin-emu/dolphin
-| download = http://www.dolphin-emu.com/downloads.php
+| download = https://dolphin-emu.org/download/
+| license = GPLv2+ (since 2015)
 | peripherals =
 }}
-'''Dolphin''' emulates the Wii and GameCube consoles, as well as various accessories for and derivatives of said consoles. It runs Wii, GameCube and [http://en.wikipedia.org/wiki/List_of_Sega_arcade_system_boards#Triforce Triforce] software on a x86 or x86_64 PC (Windows, Linux, OS X). As of June 2008 Dolphin's source was released under the GPLv2 license and is under active development.
+'''Dolphin''' emulates the Wii and GameCube consoles, as well as various accessories for and derivatives of said consoles. It runs Wii and GameCube software with a x86_64 JIT (Windows, Linux, FreeBSD, macOS) and AArch64 (Android). On June 2008, Dolphin's source was released under the GPLv2 license and is currently under active development.
 == Obtaining a build ==
-=== Compilation from Source ===
-Follow the instructions to build under [http://code.google.com/p/dolphin-emu/wiki/WindowsBuild Windows], [http://code.google.com/p/dolphin-emu/wiki/Linux_dependencies Linux] or [http://code.google.com/p/dolphin-emu/wiki/MacOSX_Build MacOSX].
-=== Recommended third party builds ===
+=== Recommended builds ===
-The fan-run site [http://www.dolphin-emulator.com dolphin-emulator.com] provides daily [http://www.dolphin-emulator.com/download.html windows builds] from SVN and a [http://www.dolphin-emulator.com/faq.html FAQ] to help users.
+[https://dolphin-emu.org dolphin-emu.org] provides a buildbot for [https://dolphin-emu.org/download/ Windows and OS X builds] from Git and a [https://dolphin-emu.org/docs/faq/ FAQ] to help users.
+=== Building from source ===
+Follow the instructions to build under [https://github.com/dolphin-emu/dolphin/wiki/Building-for-Windows Windows], [https://github.com/dolphin-emu/dolphin/wiki/Building-for-Linux Linux] or [https://github.com/dolphin-emu/dolphin/wiki/Building-for-macOS macOS]. Windows and macOS users can use the buildbot to avoid compiling their own source code, but Linux users have to build it themselves in order to use Dolphin.
 == Usage with Homebrew ==
-# Run Dolphin
+From the menu, '''File''' -> '''Open...'''. Select the elf or dol file you would like to run.
-#* If you compiled Dolphin, run the appropriate executable located within Binary\''Platform'' directory, where ''Platform'' is win32, linux, etc.
-# Run your homebrew
+Note that you can cause the screen to be rendered to the main Dolphin window with the '''Graphics''' → '''Render to main window''' option.
-#* From the menu, '''File''' -> '''Open...'''. Select the elf or dol file you would like to run. If successful, a new window will be displayed with the output.
-#** Note that you can cause the screen to be rendered to the main Dolphin window with the '''Config'''->'''Display'''->'''Render to main window''' option.
 === General Notes / Disclaimer ===
 * Dolphin is useful to homebrew as it allows developers to test code on a PC before running it on real hardware. However, Dolphin does not support all the features of the Wii and some problems may be experienced running homebrew.
-* Dolphin hooks the typical printf functions when it is able to determine their location. If you are running an elf file (with symbols), and cannot see your debug output, this is could be the reason. Either strip your elf, run the dol, or modify dolphin so this HLE does not take place. The other reason could be that you are writing directly to the XFB (libogc's console output does this). In this case, you additionally need to enable the '''Graphics'''->'''Use Real XFB''' setting.
+* You may want to enable the MMU for more accurate emulation.
-* Homebrew applications ''may'' hang while initialising sound, i.e. on calling ASND_Init(). A work around would be to skip sound initialisation, so no sound, but there's no need to remove other sound calls in your code.
+* Dolphin hooks the typical printf functions when it is able to determine their location. If you are running an elf file (with symbols), and cannot see your debug output, this is could be the reason. Either strip your elf, run the dol, or modify dolphin so this HLE does not take place. The other reason could be that you are writing directly to the XFB (libogc's console output does this). In this case, you additionally need to enable the '''Graphics'''->'''Hacks'''->'''External Frame Buffer''' setting and check '''Real'''.
-* You can find an '''SD Card''' image in something like \User\Wii\sd.raw, kept in the Dolphin folder.  If missing it may create it on the first run, you can add things to the sd.raw image with a tool such as winimage.
+* Homebrew applications ''may'' hang while initialising sound, i.e. on calling ASND_Init(). A work around would be to skip sound initialisation, so no sound, but there's no need to remove other sound calls in your code. Using the '''DSP LLE''' audio backend will improve sound accuracy, and may help avoid hangs.
-* When using code that makes use of the SD Card make sure you use the '''full path''' name i.e. (sd:/apps/MyApp/gfxfiles/Image.png), using a relative path (/gfxfiles/Image.png) will not work as your application is launching from an unknown location.
+* You can find an '''SD Card''' image in something like User\Documents\Wii\sd.raw, kept in the Dolphin folder.  If missing it may create it on the first run, you can add things to the sd.raw image with a tool such as winimage. On Linux, it can be simply mounted directly.
+* When using code that makes use of the SD Card make sure you use the '''full path''' name i.e. (sd:/apps/MyApp/gfxfiles/Image.png); using a relative path (/gfxfiles/Image.png) will not work as your application is launching from an unknown location.
+* When not using [[libogc]], Dolphin may run the app in GameCube mode. This can be fixed by inserting the u32 <code>0x7c13fba6</code> in a text segment. This instruction does not need to run, but it needs to be in a place that causes it to exist in the binary.
 === Compatibility ===
+''Note: This section is pretty outdated''
 The following was tested with examples from devkitPro svn r4455, running on Windows 7 (64bit), Dolphin svn r6430. Apps run with default settings unless noted otherwise.
 These results are provided so that one can quickly realize which options are needed for common tasks - such as using SD support, homebrew text console, etc.
@@ Line 41: / Line 45: @@
 |-
 | examples\wii\audio\*
-| Work acceptably. Requires DSP LLE plugin to be used. Audio may have artifacts.
+| Work acceptably. Requires '''DSP LLE''' plugin to be used. Audio may have artifacts.
 |-
 | examples\wii\devices\network\sockettest
@@ Line 47: / Line 51: @@
 |-
 | examples\wii\devices\usbgecko\gdbstub
-| "Works". Will run and call _break(), however a usbgecko device is not emulated, so this technique is useless. There are better ways to accomplish similar functionality with dolphin.
+| Works correctly. Requires '''USBGecko''' device selected. Sets up a TCP server to accept connections (instead of a serial device). The TCP port used will be displayed on-screen when dolphin begins emulation.
 |-
 | examples\wii\devices\usbkeyboard\basic_stdin
-| Works correctly. Requires '''Graphics'''->'''Use Real XFB''' to be enabled. Requires '''Config'''->'''Wii'''->'''Connect USB Keyboard''' to be enabled.
+| Works correctly. Requires '''Graphics'''->'''Hacks'''->'''External Frame Buffer'''->'''Real''' to be checked. Requires '''Config'''->'''Wii'''->'''Connect USB Keyboard''' to be enabled.
 |-
 | examples\wii\filesystem\directory
-| Works correctly. Requires '''Graphics'''->'''Use Real XFB''' to be enabled. Requires '''Config'''->'''Wii'''->'''Insert SD Card''' to be enabled.
+| Works correctly. Requires '''Graphics'''->'''Hacks'''->'''External Frame Buffer'''->'''Real''' to be checked. Requires '''Config'''->'''Wii'''->'''Insert SD Card''' to be enabled.
 |-
 | examples\wii\graphics\gx\gxSprites
@@ Line 68: / Line 72: @@
 |-
 | examples\wii\template
-| Works correctly. Requires '''Graphics'''->'''Use Real XFB''' to be enabled.
+| Works correctly. Requires '''Graphics'''->'''Hacks'''->'''External Frame Buffer'''->'''Real''' to be checked.
 |}
@@ Line 74: / Line 78: @@
 <gallery>
 File:Dolphin_nehe5.PNG|Running NeHe lesson5
-File:Dolphin (Emulator) screenshot.png|Gamelist view with retail games
+File:Dolphin Emulator Main and About Windows.png|Dolphin main window and About window
 </gallery>
 [[Category:Open source homebrew]]
-[[Category:Software]]
+[[Category:Wii models]]