How to use the Official GameCube Controller Adapter for Wii U in Dolphin

From Dolphin Emulator Wiki
Jump to: navigation, search
Official GameCube Controller Adapter for Wii U

As of 4.0-4599, Dolphin has built in support for the Nintendo GameCube controller Adapter for Wii U, the only official USB GameCube adapter available. With Dolphin's implementation, the GameCube controller is auto-configured and calibrated, with full rumble support. Wireless controllers and bongos are supported.

This guide is primarily for the official adapter, but third-party adapters that are compatible with Super Smash Bros. for Wii U generally also work. If your adapter has a switch for choosing between PC mode and Wii U mode, set it to Wii U mode before following these instructions.

Installation

Linux

Linux support does not require any special drivers, as long as Dolphin was built with libusb support. However, a udev rule must be created to allow access to the device.

Paste the following in the /etc/udev/rules.d/51-gcadapter.rules file (/lib/udev/rules.d/51-gcadapter.rules if making a package):

SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="0337", MODE="0666"

Reload udev rules with: sudo udevadm control --reload-rules

Then re-insert the adapter. Dolphin should now detect it in the controller settings (refer to #Dolphin Setup below).

If you want to change the rule, links for instructions are available on the libusb FAQ.

macOS

Due to the nature of Apple's HID implementation, all HID devices (including non-standard ones) are intercepted by IOKit's HID driver. Since the adapter does not supply a valid report descriptor, this makes the IOKit driver useless for direct communication.

Instead, IOKit's behavior may be manipulated via a codeless .kext to simply ignore the adapter and permit a lower-level connection (like the one Dolphin makes):

Easy Install

Installer Package

Terminal Install

Standalone Kext

sudo cp -r ~/Downloads/SmashEnabler.kext /Library/Extensions/SmashEnabler.kext
sudo chown -R root:wheel /Library/Extensions/SmashEnabler.kext
sudo touch /Library/Extensions
sudo reboot

Once installed, Dolphin should be able to recognize that the adapter has been plugged in. You do not need to configure the controllers manually within Dolphin's controller settings but any controllers plugged into the adapter should work immediately.

For questions on any of these macOS connection techniques, please see the forum thread.

macOS with System Integrity Protection (SIP)

For newer versions of macOS, the unsigned Kernel Extension will fail to load. The only current workaround is to disable kernel-extension signing verification, which can be done in OSX Recovery Mode. This will lessen security, and is not recommended.

csrutil enable --without kext

See this StackExchange thread for more details.

Windows

On Windows, the GameCube controller adapter will need a certain driver to let Dolphin detect it and use it.

Avoid vJoy

The software that utilizes vJoy drivers, such as GameCube USB Adapter Driver, can treat the GameCube controllers as generic gamepads for Windows. They can be configured in Dolphin like any other controller. Unlike vJoy, Dolphin's native support will offer more straightforward and added missing supports from vJoy (i.e. force feedback), and offer better latency. vJoy and Dolphin's native support conflict with one another, so to use the native support in Dolphin, driver services must be stopped through GameCube USB Adapter Driver 's window. You probably already have ran Zadig setup if the GameCube USB Adapter Driver version is v3.0 or later. Skip to #Dolphin Setup below if you haven't encountered any problems with it.

Windows

If you are using 5.0-2472 or newer, you need to either install a filter driver using Zadig or install UsbDk. (Doing both is unnecessary, but doesn't lead to any problems.) If you aren't sure which one to pick, use Zadig and follow the instructions below.

If you are using 5.0-2341 or older, using Zadig is required.

Using Zadig

Plug in the GameCube controller adapter if it hasn't been already. Download and launch Zadig. If you're using the Mayflash adapter, make sure you switch it to "Wii U" or Zadig won't pick it up properly.

1. From the "Options" menu in Zadig, select "List All Devices"

2. In the pulldown menu, select "WUP-028". Ensure that its USB ID is "057E 0337".

  • If it does not appear in the list then try inserting the adapter (specifically its black USB cord) into another USB port.

3. On the right column, select "WinUSB" then click "Replace Driver". Select "Yes" to modify the system driver.

When it said the driver is installed successfully then you can close the Zadig setup and continue to #Dolphin Setup below.

Problem with Zadig?

If there is a problem in the installation process, you can completely restart Zadig by following these instructions.

Reverting the adapter's driver back to vanilla state

  • Open Device Manager (or simply run "devmgmt.msc"), look for the "WUP-028" device which is usually under the "Universal Serial Bus devices". Open its context menu (right-click) and select Properties. Click "Uninstall" under the "Driver" tab. Check box "Delete the driver software for this device" then proceed. Then re-insert the adapter. The steps for driver installation can now be followed.

Delete temporary setup files (Fixes "Driver installation failed")

  • Kill installer_x64.exe or installer_x86.exe from the Task Manager then delete %userprofile%\usb_driver\ and run Zadig again.

Android

Android doesn't require anything special to make the adapter work. Under the gamepad controller settings; For each controller that you want to use the adapter with, change the selection from Emulated to Gamecube Adapter. After that point, make sure to start the game with the adapter plugged in and Android will ask if you want Dolphin to have permission to use the device.

Input doesn't work

There is a bug in Android's USBManager framework that sometimes causes Dolphin to be incapable of reading the adapter. In these instances a toast window will pop up asking you to unplug and replugin the adapter. Do so and Dolphin will be able to read the adapter after that.

Dolphin Setup

The left slot on the adapter (while engraved "Wii U" facing up) is the first port, and so on, so don't mistake it for being the other way around!

Before Dolphin 4.0-4599

The GameCube controller adapter is not supported in versions older than 4.0-4599. Updating to a newer version is necessary.

Dolphin 4.0-4599 to Dolphin 4.0-8593

With any necessary installation complete, run Dolphin, and check Direct Connect under GameCube Adapter in the Controller Settings, then restart Dolphin. Set GameCube ports to Standard Controller corresponding to each port on the adapter that is plugged in with the actual GameCube controller. The setup for the adapter is now completed. To test, simply start a game that uses GameCube controllers.

  • DK Bongo controllers are supported. With DK Bongo controllers plugged in, select "TaruKonga (Bongos)" in the Controller Settings.
  • Dolphin supports hot-plug, so the pads can be unplugged and plugged into other ports. If a pad is unplugged from the adapter, Dolphin will use what is configured (PC keyboard/mouse, PC gamepad etc).

Dolphin 4.0-8601 and Newer

With any necessary installation complete, run Dolphin and click the GameCube controller dropdown. Select GameCube Adapter for Wii U on any slot that you wish to use the adapter for. Hitting Configure when this is selected allows you to turn rumble off/on per controller, as well as a toggle for using the DK Bongos.

Unlike 4.0-8593 and before, you will have to choose between GameCube Adapter for Wii U or Standard Controller for a real GameCube controller or the device emulating a GameCube controller. The hot-plug properties are also removed.

Adapter Not Detected

It's worth noting that only the first instance of Dolphin Emulator will detect the adapter. Another instance will detect the second one if inserted, and so on. If the Dolphin Emulator couldn't detect the adapter, it's possible that you already have another one running.

Dolphin might not show the correct status of the adapter if Direct Connect is unchecked. Check that then restart Dolphin.

If the adapter is not detected at all, then it may only be a matter of changing USB ports and restarting Dolphin, or its driver/setup might have recently been changed/overridden. You should follow the instruction again from one of the sections for your system.