Retroarch

From OoT Randomizer Wiki
Revision as of 13:18, 20 August 2021 by Blackwall (talk | contribs) (Common Issues)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

by Raizuto

RetroArch is the only cross-platform emulator supported by the Ocarina of Time Item Randomizer staff. It is also possible to use it to play a vast number of platforms other than N64 as well. This might just make it your emulator of choice once you get used to using it.

Installing RetroArch

RetroArch Downloads Page and Download Stable button

Go to the RetroArch downloads page and click the button labeled Download Stable. Run the installer file it downloads.

Windows Specific Installation

On Windows you may get a popup when trying to run the installer that warns you if you do not have DirectX 9.0c installed1. Press OK to continue. Click Next > until it asks you where you would like to install RetroArch2. The default path should be C:\Users\<yourusername>\AppData\Roaming\RetroArch. If it does not display this location it is recommended to copy and paste the following text into the box: %AppData%\RetroArch and then continue clicking Next >. Soon you will see the Choose Components screen3. Make sure you click the checkbox next to DirectX 9.0c Runtime before clicking Next >. Keep clicking Next > until the Install button appears. Once you click Install RetroArch will begin installing.

Before RetroArch finishes installing it should pop up the DirectX installer. Click Next > until you get to the screen offering to install the Bing Bar4. You should uncheck Install the Bing Bar before clicking Next >. Once you finish the DirectX installation the RetroArch installation will finish as well.

Mac Specific Installation

Downloading and Installing

Go to the RetroArch downloads page and download the Apple macOS / OSX Intel build. This will work with High Sierra and above (including Mojave and Catalina). Don't download the Apple macOS High Sierra (and later) with Metal2 build as the ParaLLeL Core will not work. This may change in the future.

When downloading, ensure that the downloaded application is copied to the desktop as shown in the official installation video provided on the download website. DO NOT open from the disk image. If you opened RetroArch from the disk image, copying it from the Desktop should resolve the issue immediately. If it does not, you'll need to delete your retroarch.cfg file.

Install a RetroArch Core

You should now be at the Main Menu of RetroArch1. You can switch between the different menus on the left side of the screen when you are on the top-most sub-menu of a menu. If you can't see the left sidebar with the different menus listed and you need to switch which menu you are in, you can press Backspace, X, or the Right Mouse Button until you see it again. To open a menu, submenu, or option you can press Enter or Z while it is highlighted, or Left Mouse Button while hovering over it. Keep in mind that these are the default controls in RetroArch. If you change these keyboard bindings in the Settings menu, you'll have to use the buttons you bound to A or Start to select, and the buttons you bound to B or Back to go back to the previous menu. Using the mouse controls should always work properly, so we will assume you are using them throughout the rest of the guide.

On the Main Menu click on the Load Core option. In the Load Core submenu, you will normally see your installed cores. Since you just installed RetroArch you won't see any. Click the Download a Core option2. In the Core Updater menu that appears, scroll down to the Nintendo - Nintendo 64 options. It is recommended that you choose the Nintendo - Nintendo 64 (Mupen64Plus-Next) core option3. You can also choose the Nintendo - Nintendo 64 (ParaLLEl N64) core option if you Next doesn't work for you. Windows Users: the Nintendo - Nintendo 64 (Mupen64Plus-Next GLES3) option should not be chosen. This is a special build of the Mupen64Plus-Next core intended to run on XBox One devices. It will not run on Windows PCs.

Configure RetroArch

From the top menu level of the Main Menu click on the Settings menu below the Main Menu in the sidebar on the left. Scroll down to Saving and change SaveRAM Autosave Interval1 to 10 seconds by clicking it, and the scrolling down to 10 seconds.

Next, go back to the top level menu of Settings. Scroll down and select the option Directory2. In the menu this opens scroll down and select the option called File Browser3. You will be presented with an overview of your system partitions. Navigate through your computer files to the folder you keep your ROMs in. They will not show up yet. Choose Use this directory4 anyway. Most browsers will save your randomizer ROM to your Downloads folder by default5. However, if you are using the downloaded version of the Ocarina of Time Randomizer the default location for your patched ROMs is a folder called Output next to the .exe file you double click to start the randomizer.

Once you have finished configuring RetroArch you must properly restart it. Do not press Esc or the X in the top right corner. Go back to the Main Menu and move all the way down to the option near the bottom Quit RetroArch6. Once you reopen RetroArch go to Load ContentStart directory. You should now see your ROMs7. When you choose one of your ROMs it may ask you which core you want to use if you downloaded more than one of them. It is recommended that you choose Nintendo - Nintendo 64 (Mupen64Plus-Next)8 for the best peformance and fewest bugs.

Required Settings for Racing

If you wish to partake in our community's races, then don't forgot to also configure the settings mentioned here.

Keyboard Configuration

If you are going to use a controller, skip this section.

Head to SettingsInputPort 1 Input Binds. An example of some control binds when using a keyboard can be found here.

Controller Configuration

First, take a look at the Controller Setup guide. Ensure your controller is calibrated, and if you are using one of the controllers with additional setups steps in that guide make sure you follow them.

If your controls don't feel quite right, while running the ROM press F1 to access the Quick MenuOptions menu. If your stick causes input without you trying to, change the Analog Deadzone to 10 or higher if that is not enough. If you aren't able to both walk and run increase Analog Sensitivity to make it easier to run. Decrease it to make it easier to walk.

Remap Your Controls

You'll probably need to customize your controller inputs by loading your ROM and pressing the F1 key to bring up the RetroArch Quick Menu. Choose Controls ⇒ Port 1 Controls. Highlight the control on your controller on the left side and press and to cycle through the available N64 controller options on the right side.

Make sure C-Buttons Mode is not bound to any of your controls. This is intended for controllers without enough buttons/a right analog stick to map C-Buttons to and usually causes controller issues.

Gamecube Style C-Buttons

If you want to emulate the Gamecube controller's style of C-Buttons, where they are bound to the right analog stick and the the extra face buttons on your controller, you need to enable another setting. Press F1 to open the Quick Menu and scroll down and select Options. Scroll down and switch the Independant C-button Controls from False to True. This will add controls like C-Down and C-Up to the right side of the Controls remappings.

Head back to the Quick Menu and go over to ControlsPort 1 Controls and map your face buttons to the C-* options, and your right analog stick to the C Buttons * analog control values.

GameCube Controller Setup

MayFlash GameCube Adapter

Make sure the switch on the back of your controller is set to PC. If you just downloaded RetroArch the controller should just work. If not, go to Online Updater on the Main Menu and choose Update Joypad Profiles. Once it finishes downloading and extracting the zip file, restart RetroArch.

Your controller should now be working. If it isn't you can try the different controller ports or go to SettingsInputPort 1 Input Binds. Highlight Device Index and press or to choose the correct MAYFLASH Controller number.

Using Custom Drivers (Zadig)

Skip this section if you have a MAYFLASH GameCube Adapter.

Make sure the GCN USB Adapter program is running.

Start RetroArch and go to SettingsDrivers and make sure Joypad Driver is set to xinput. Then use the Quit RetroArch option in the main menu to properly close RetroArch and save your new configuration if you changed it.

You'll want to save this configuration file as vJoy_Device_GameCube.cfg in your RetroArch XInput autoconfig directory. You should find this folder by pasting %AppData%\RetroArch\autoconfig\xinput in the Windows Explorer address bar and pressing Enter. Once that file is in place start RetroArch. You should get a message saying something like vJoy device #1 configured in Port #0.

If your controller is not working still, click on the Windows Gamepad Info button to bring up the list of connected controllers on your computer.1 The vJoy gamepads should be in order of what number RetroArch is expecting. Try each one by clicking it's entry, pressing the Properties button and moving the control stick. Whichever on causes the cursor in the square to move is the number you want to remember. Go back to RetroArch and head to SettingsInputPort 1 Input Binds. Highlight Device Index and press or to choose the correct vJoy Device number.2 You may have to do this every time you restart the driver application.

Your controller should now be working.

Switch Pro Controller

You'll need to install Steam.

Next, you'll need to add RetroArch to Steam as a non-Steam game

Afterwards, right-click on your Steam icon and go to Settings. Click on the Controller section and click on General Controller Settings.

Make sure Switch Pro Configuration Support is checked.

You should now be able to configure your Switch Pro Controller in RetroArch (through Steam).

ParaLLEl Graphics Configuration (Console-Accurate Graphics)

The ParaLLEl core will use the glide64 graphics plugin by default and Mupen64Plus-Next will use GLideN64 by default. Glide64 is a plugin that works well on many graphics cards, but has several graphical issues. GLideN64 is actually fairly good at displaying things properly, but still doesn't always work exactly how graphics would work on the N64. ParaLLEl and Mupen64Plus-Next have a graphics plugin that is nearly flawless in recreating N64 graphics, but requires somewhat modern hardware to run, and will perform slower overall than the other available plugins. If you have a graphics card made after 2012 it should support this more accurate plugin.

Check If Your Hardware Supports Vulkan

You can check this website to see if your graphics card supports any version of Vulkan. If you're not sure what GPU your computer has, try one of these methods to find out. If you find your graphics card supports Vulkan you can continue. If it does not, please do not proceed. You may cause ParaLLEl to start crashing if you try to follow these instructions without a compatible graphics card.

Activate parallel RDP And RSP

If your ParaLLEl or Mupen64Plus-Next core was downloaded before June of 2020, please make sure it is up-to-date now by going to Main MenuOnline UpdaterUpdate Installed Cores to update your cores.

Now load a ROM with the either core. Open the Quick Menu by pressing F1 or whatever hotkey you have bound to open the menu in RetroArch. Select Options and scroll down to GFX Plugin and set it to parallel. Scroll down to RSP plugin and also set it to parallel. While you are here you will probably also want to set (ParaLLEl-RDP) Upscaling factor (restart) to 2x. If you experience performance issues, be sure to try setting this back to 1x first to see if it improves.

Texture Packs

The following link will let you set up texture packs for RetroArch

Tips

  • To unbind any button/key hit the Delete key on your keyboard in the input settings.
  • Never close RA via it’s top right X, close it from far left Main Menu Quit RetroArch.
  • If you want RetroArch to keep running in the background, go over to the Settings column in the menu, then down to User Interface, hit Enter and set Don’t run in the background to OFF.
  • To enable the FPS display, go to SettingsOn-Screen DisplayOn-Screen Notifications and switch On-Screen Notifications to ON if it is not already. Then, change Display Framerate to ON.
  • To be able to position the FPS counter, go to SettingsOn-Screen DisplayOn-Screen Notifications and set Graphics Widgets to OFF and then restart RetroArch.


If your controller does not have a default profile or you are using a keyboard, the following information may be helpful.

  • Don't alter the Main Menu bindings for controllers that have default profiles. Open the Quick Menu and change the button mapping there instead.
  • Left side user input binds (the Delete key will delete any binding)
    • B button is equivalent to N64 A Button
    • Y button is equivalent to N64 B Button
    • L2 button (trigger) is equivalent to N64 Z Button
    • L1 is equivalent to N64 L
    • R1 is equivalent to N64 R
    • Movement:
      • Left analog X+ = Right
      • Left analog X- = Left
      • Left analog Y+ = Down
      • Left analog Y- = Up
    • C-Buttons/C-Stick:
      • Right analog X+ = C-Right
      • Right analog X- = C-Left
      • Right analog Y+ = C-Down
      • Right analog Y- = C-Up

Common Issues

There are several issues that can occur in RetroArch.

Abnormal FPS Increases

Go to SettingsFrame Throttle and set Fast-Forward Rate to 1.0x.

Boots are equipped / Ocarina pulled out randomly while walking

Go to the SettingsInputPort 1 Input Binds menu and set Analog to Digital to None.

Crash when loading ROM

If using the Nintendo - Nintendo 64 (Mupen64PlusNext) core, try the Nintendo - Nintendo 64 (ParaLLEl N64) core instead. If using the Nintendo - Nintendo 64 (ParaLLEl N64) core, try the Nintendo - Nintendo 64 (Mupen64PlusNext) core instead.

Input Lag

If you're experiencing abnormal input lag with your controller, go to SettingsLatency and adjust the Polling Behavior.

Mupen64Plus-Next Freezes

This is an issue with versions prior to Mupen64plus-Next 2.3 which was released on July 14, 2021. Please update yor cores from the Cores Updater in the main menu. Also, after loading a ROM press F1 to open the Quick Menu. Under Options Move down to Ignore emulated TLB Exceptions and press the arrow key until the selection changes to Don't Ignore.

Mupen64Plus-Next Epona Carrots

This is an issue with versions prior to Mupen64plus-Next 2.3 which was released on July 14, 2021. Please update your cores from the Cores Updater in the main menu. Also, after loading a ROM press F1 to open the Quick Menu. Under Options Move down to Ignore emulated TLB Exceptions and press the arrow key until the selection should changes to Don't Ignore.

My A and B Buttons Are Swapped On The Menu

Go into SettingsInputMenu Controls and change the Menu Swap OK & Cancel Buttons option.

My Remapping in Quick Menu Controls Won't Save

If your remapping won't save even after using Quit RetroArch in the main menu, you may have to explicitly save the remappings. Open the Quick Menu with F1, go down to Controls and map your controls how you wish. Once you have done so, go back to the Controls menu. Near the top of the menu is a Save Core Remap File option. Select this to save these controller binds for all randomizer ROMs you open in the future.

No Audio

Go into the SettingsDrivers menu and change the Audio Driver from xaudio to dsound. Then quit RetroArch properly via the Main Menu and restart it.

One of My Buttons Won't Work

If you messed with the Main Menu User Input Binds you likely configured something wrong. It is not recommended to ever modify controller binds this way unless your controller doesn't have a built in profile. To reset your controller bindings to their default you have to load the default RetroArch.cfg again.

If you have a ROM loaded, start by pressing F1 to open the Quick Menu then press Backspace to get back to the Main Menu.

Go to the far left menu item, Main Menu. Move down to 'Configurations and press Enter. Select <Parent directory> and hit Enter. Scroll down to the file RetroArch.default.cfg and press Enter.

Overwriting Controller Autoconfig(s)

If you've inadvertently overwritten a controller autoconfig, you'll need to close RetroArch. Next, go to your RetroArch folder and delete the autoconfig folder. Afterwards, launch RetroArch and go to Main MenuOnline Updater and click on Update Controller Profiles.

ParaLLEl Black Screen or Crashes

If you are able to launch the ParaLLEl core but get a black screen, or frequently crash while pausing, try changing the video plugin it is using. Press F1 to open the Quick Menu and move down to Options and press Enter. Next, move down to GFX Plugin and press the arrow key once. Once you have changed the option, press Backspace twice to return to the Main Menu and select Quit RetroArch to close RetroArch. Simply run RetroArch and open the ROM again and your ParaLLEl core should be running the new plugin you selected. Try each one and see if any of them work for you. If they do not, you may want to try the Mupen64Plus-Next core instead.

retroarch.cfg (for Mac users)

If you need to delete/modify this file, you'll need to access the Library. To access the library, it must be “shown" as it's hidden by default. The easiest method to do this is while in the Go dropdown menu, hold the option button and it will appear. Search “retroarch” in the Library and the folder and files will show up.

Waiting on Client (Error Message)

Waiting on client ...
You have rejoined the game as player 1
null

This is a rare issue and can be a hindrance when racing. According to the RetroArch devs, this is an issue that occurs with some virtual gamepads, when explorer.exe isn't running, or other random-seeming situations.

The only feasible solution at this point is to go to SettingsInputHotkeys and bind a hotkey to Netplay Hosting (Toggle) so that you can immediately toggle out of this.