Dolphin: Difference between revisions

From OoT Randomizer Wiki
(fixed some small mistakes about what things are called in dolphin)
(mention that dolphin updates can reset aspect ratio setting to default)
Line 108: Line 108:
=== Aspect Ratio ===
=== Aspect Ratio ===


Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select whatever you prefer.
Go to <kbd><samp>Graphics</samp> ⇒ <samp>General</samp> ⇒ <samp>Aspect Ratio</samp></kbd>, and select whatever you prefer. Note that if you update Dolphin, this setting may return to its default state of 16x9.


[[File:DolphinAspect.png|RTENOTITLE]]
[[File:DolphinAspect.png|RTENOTITLE]]

Revision as of 16:27, 6 October 2021

Please keep in mind that:

  1. Dolphin has not been tested extensively for OoTR.
  2. Using Dolphin for racing is against our community's racing rules.

Dolphin is a popular emulator for both Gamecube and Wii games, but it can also be used to play Ocarina of Time Randomizer on thru the Wii's Virtual Console mode. Dolphin is very good at emulating Wii VC and only suffers from potential slight additional lag in certain areas (such as Market as child), which can be mitigated using settings discussed below. However, compared to N64 emulators Dolphin inherits the advantages of faster load times and faster pausing from Wii VC. It's also not as resource intensive as some of the alternatives. That being said, playing OoTR on Dolphin is still largely experimental, and this page will be updated as more issues and fixes for those issues are found.

While Dolphin will be used as a Wii emulator, it is actually much simpler than setting up a Wii. There is no need to softmod, move data onto an SD card, or install a WAD. That being said, there are some steps that need to be taken first.

First Time Dolphin User Set Up

Download the latest beta release of Dolphin. Like other emulators, you will need the latest beta release of Dolphin rather than the latest stable release. Note that, by default, Dolphin will check for a new beta release monthly and auto-update. You will need a version specific to the operating system you use, see below for details.

Windows

Once Dolphin is downloaded, extract the zip and open Dolphin.exe. You should see something like this (except that, if this is your first time, your games list will be empty):

RTENOTITLE

Note the buttons within the red box, these will be used in the upcoming steps. The first thing you will want to do is create a game directory. Go to ConfigPathsAdd... and select the directory in which you would like your games to be placed. You can even have multiple game directories, if you wish. This will then cause any .iso or .wad files in your selected directory to show up in the home menu, as seen above.

RTENOTITLE

Click on Controllers on the home page. Controllers can be setup either as "GameCube Controllers", or as "Wii Remotes". For the purpose of the randomizer your controller will need to be configured as a "GameCube Controller" (even if it is, say, an Xbox controller). Under Gamecube controllers, click Configure next to Port 1.

DolphinControlConfig1.png

If you are using a Gamecube Controller with a Wii U Adapter by either Nintendo or Mayflash (Wii U mode), then your controller should be detected and configured automatically and the new window that opens will simply ask you to enable/disable the Rumble Pak.

RTENOTITLE

For reference, these are the default controller mappings Dolphin will use. Keep in mind that if you've used the webpatcher, or gzinjectgui with the right configuration, that D-pad left/right/down will be overwritten to properly work with boots/ocarina on D-pad.

RTENOTITLE

If you are using any other controller, or if you're using a Gamecube adapter in PC mode, then you will need to configure the controller yourself. Note that, even if you have a controller with analog triggers, you must set L and R for the buttons to work properly, not just L-Analog and R-Analog. Below shows a sample controller config with an Xbox controller.

DolphinControlConfig2.png

Mac OS

On the Dolphin page, download the latest MacOS Intel version and drag to Application folder per normal installation.

Mac Download Page

The Disk Image (DMG) will include Dolphin and the Dolphin Updater.

Mac OS Dolphin DMG

Similar to the Windows setup, create a filepath directory to where the WAD will be located.

Dolphin main screen

For setting up controllers, you may use either USB or BlueTooth enabled devices. In the controller setup screen, configure your specific setup and map the button inputs. Virtual notches can be configured in this screen as well.

Controller Configuration screen

Randomizer Dolphin Set Up

So, now you have either just finished setting up Dolphin for the first time, or are an experienced Dolphin user. There are a few more settings that must be set to certain values to properly play the randomizer.

First, under ConfigGeneral make sure that Allow Mismatched Region Settings is unchecked and Fallback Region is set to NTSC-J. This ensures that you don't get a PAL frame rate.

DolphinRegion.png

Next, under GraphicsHacks, ensure that Store EFB Copies to Texture Only is unchecked. This fixes the black pause screens

Setting for EFB

Enable FPS Display

In the first tab of the Graphics Configuration in the Other section, check the box which says Show FPS.

Starting a Seed

This is the only part of setting up Dolphin which is similar to the set up for Wii VC. Refer to the "Generating a Seed" section on the Wii VC page for how to generate a WAD.

After generating the WAD, place it in your game directory. It should appear in your home menu. Double-clicking the seed should then launch it the same way any other .iso is launched from Dolphin, no NAND installation or Wii channel required. If there is already an in-game save file present, delete it before starting the new seed.

After Finishing a Seed

Since all OoTR WADs use the same internal ID, Dolphin will consider them all the same game, meaning saves will carry over between seeds. You'll just need to delete the old save data to make room for a new save.

Optional Settings

Recommended Baseline Settings

If you are experiencing lag, these are optional settings to change from default.

First go to Options => Graphics Settings, and then in the General tab change the Backend from OpenGL to Vulcan if you are on Windows. Dolphin recommends switching this driver as there may or may not be performance driven issues using OpenGL and its compatibility: Dolphin Performance Page

Video Driver Screen

Second, there are optional graphics settings enabled for more frame rate heavy games which are not required for Ocarina of Time. Below are some settings to verify if you are experiencing lag and what to uncheck.

Under the Enhancements tab

Advanced Tab

Graphical Enhancements

Depending on the power of your computer, you may want to enable some graphics enhancements. If your computer can handle it as it makes games look much nicer. Back on the home page, go to GraphicsEnhancements. There is no exact guide for what to do here, mouse over each individual component to see what it does. If your computer is powerful enough, you can probably enable most things without worrying about it. Otherwise, you may have to do some trial and error to figure out what your computer can handle. Per-Pixel Lighting and Anti-Aliasing above 4x are particularly demanding. Post-Processing Effects are mostly gimmicks.

DolphinEnhancements.png

Aspect Ratio

Go to GraphicsGeneralAspect Ratio, and select whatever you prefer. Note that if you update Dolphin, this setting may return to its default state of 16x9.

RTENOTITLE

Troubleshooting

These are common issues with running Dolphin. If you are having issues, try any of these that seem like they may help. If you continue to have problems running the randomizer in Dolphin, please come to #setup-support on our Discord.

MacOS will not open Dolphin

Some security settings may affect whether the application has privledges to write to a file directory. This can be overridden by giving permission to Dolphin to write to Finder. Open Terminal and in the command line copy these two commands and run them in one after the other:

sudo xattr -r -d com.apple.quarantine /path/to/Dolphin.app

sudo xattr -r -d com.apple.quarantine /path/to/DolphinUpdater.app

Change where it says path to your path directory location before running the command. You can copy the path by right clicking Dolphin.app with Opt key held and click Copy Path Name.

After running the commands, Dolphin should reopen normally.

Performance may be poor message on startup

When starting the emulator, yellow text may appear which says "Performance may be poor". This only occurs on older computers or computers with specifications lower than Dolphin recommends. Refer to the previous section on Optional Settings to decrease Graphical Enhancements and change Video Driver. Actual gameplay may not be affected, however you may experience some lag.

Performance may be poor

The Game is Running Slowly/Less than 20 FPS

The first thing you need to do in this case is look to the top left of your emulation window. There it should display both FPS and VPS. FPS is the framerate of the game you're running, while VPS is the framerate of Dolphin's output. Based on the VPS value, continue to one of the following subsections.

RTENOTITLE

VPS is less than 60 and unstable

If this is the case, your computer can not handle the current emulation, you should turn down some of your graphical enhancements.

VPS is stable at 50

There is likely some issue with the region being stuck at PAL, ensure you took the proper steps regarding the region in Randomizer Dolphin Set Up.

VPS is stable at 60

This one is much trickier, as this implies that, as far as the emulator is concerned, the game is running at full frame rate. This should be a last resort, go to ConfigAdvancedClock Override, checking Enable Emulated CPU Clock Override, and setting the slider to 200% (or whatever number seems to work for you). This is not allowed for racing.

RTENOTITLE

The Wii Home Menu Randomly Pops Up

Click on Controllers on the home page and then either untick Background Input (your controller inputs will still be registered with this setting unticked even when the window is unfocused), or change the HOME binding of Wii Remote 1.

GFX FIFO Unknown Opcode on Resetting

This is a known bug with resetting VC on Dolphin. You can click OK on both dialogs that pop up and then won't have to worry about it again until you restart Dolphin itself. You can also go to OptionsConfigurationInterface and disable Use Panic Handlers to always ignore it.