DSU Client

From Dolphin Emulator Wiki
Jump to navigation Jump to search

Since 5.0-11083, Dolphin can act as a client of the DSU protocol (often referred as CemuHook Motion Provider protocol), which enables the emulator to receive motion and input data from compatible applications implementing the server-side part of the protocol. Those servers works as a middle-man between specific input devices and client applications like Dolphin in order to provide motion data not accessible through the other input APIs Dolphin supports, like DirectInput, XInput and Windows.Gaming.Input, although they also provide data from normal buttons and axes as well.

DSU Server Applications

A list of known servers are listed below. Any server not listed here that works with CemuHook should also work with Dolphin 5.0-11083 and newer.

Linux

As of 5.0-11484, motion axles of Wii Remotes, DualShock 3/4, DualSense and Nintendo Switch controllers can be directly mapped in Dolphin through evdev input API, which generally provides better latency than DSU Servers and thus is generally preferred.

Alternatively, the following servers are available:

  • ds4drv (TheDrHax fork): compatible with all DualShock 4 controllers.
  • evdevhook2: compatible with all controllers that properly expose motion via evdev (Nintendo Switch controllers, DualShock 3/4 and DualSense).
  • joycond-cemuhook: compatible with Nintendo Switch controllers.
  • linuxmotehook2: compatible with Wii Remotes. Starting with 5.0-11684, Dolphin can map Wii Remote buttons and motion axles directly, by enabling "Connect Wii Remotes for Emulated Controller" option on Controller Settings. Consider using Dolphin's built-in functionality instead of linuxmotehook.
  • SteamDeckGyroDSU: compatible with the Steam Deck, requires SteamOS 3.0.

Windows

As of 5.0-16861, motion axles of DualShock 4, DualSense and Nintendo Switch controllers can be directly mapped in Dolphin through SDL API, which generally provides better latency than DSU Servers and thus is generally preferred.

Alternatively, the following servers are available:

  • BetterJoy: compatible with Nintendo Switch Joy-Con and Pro Controllers.
  • DorsalVR: compatible with OpenXR devices (ex: VR HMD and controllers).
  • DS4Windows (Ryochan7 fork): compatible with all DualShock 4 models, DualSense, Nintendo Switch Joy-Con and Pro Controllers. Additionally, it's compatible with DualShock 3 controllers if either the official Sony Sixaxis driver or DsHidMini is also installed.
  • OpenTrack DSU Server (experimental): allows passing through OpenTrack methods of control via UDP.
  • ScpToolkit (Nefarius fork, requires patching): compatible with DualShock 3 and older DualShock 4 controllers (model CUH-ZCT1x). Since ScpToolkit is unmaintained and has connectivity issues with the newer DualShock 4 controllers (model CUH-ZCT2x), its usage is not recommended. Consider using DS4Windows instead.
  • SI2DSU: connects to SteamWorks and serves a controller recognized by SteamInput. Allows some gyro controllers to work over Steam Link/Remote Play/In-Home Streaming.
  • Steam Gyro for CemuHook: compatible with Steam Controllers.
  • WiimoteHook: compatible with Wii Remotes. Starting with 5.0-11684, Dolphin can map Wii Remote buttons and motion axes directly, by enabling "Connect Wii Remotes for Emulated Controller" option on Controller Settings. Consider using Dolphin's built-in functionality instead of WiimoteHook.

macOS

As of 5.0-16861, motion axles of DualShock 4, DualSense and Nintendo Switch controllers can be directly mapped in Dolphin through SDL API, which generally provides better latency than DSU Servers and thus is generally preferred.

Alternatively, the following servers are available:

  • ds4macos: compatible with all DualShock 4 controllers. This server is currently broken and will work only with Dolphin 5.0-14363 or earlier.

Android

iOS

  • DSUController: provides motion sensor data and basic button functionality.
  • WiiMoteDSU: requires sideloading or a jailbroken device, provides motion sensor data and basic button functionality.

Setting up

DSU Server

  1. Download and install a suitable server application for your OS and input device.
  2. Follow the application instructions to connect your input device.
  3. Depending of the application, manually enable the "UDP Server" option (or similar).

Also, take note of the IP Address and Port where the server will be listening. On most cases, they will default to IP 127.0.0.1 at port 26760 but this might be completely different, for example, when using an Android device as motion source.

Dolphin

  1. Make sure you're running Dolphin 5.0-11083 or newer.
  2. Go to Controller Settings → Alternate Input Sources.
  3. On the DSU Client tab, mark the "Enable" checkbox, then click on "Add" and enter the IP Address and Port where the server application is listening.

If everything is working, you should now see new DSUClient/x/xxxx entries on the Devices drop-down menu shown on Emulated GameCube Controllers, Emulated Wii Remotes and Hotkey Settings windows.

Using DSU devices in Dolphin

After finishing the setup of the server and enabling the DSU Client on Dolphin, you can now bind the buttons, axes and motion sensors of the input devices in many places, including Emulated GameCube Controllers, Emulated Wii Remotes and even Hotkey Settings.

Regular buttons and axes

The configuration of regular button and axes are pretty much the same of the other input APIs:

  1. Select the corresponding DSUClient/x/xxxx entry on the Devices drop-down menu.
  2. Click on the desired binding.
  3. Press the desired button / move the desired axis on the input device.

You can also right-click a binding to show advanced options and an existing binding can be quickly cleared with a middle-click.

Motion sensors

The configuration of motion sensors are mostly used on the "Motion Input" tab (since 5.0-11083) and on "Extension Motion Input" tab (since 5.0-11478, visible only when Nunchuk is the currently selected extension) of Emulated Wii Remotes, although nothing prevents you from binding the motion sensor axles in other places as well. By default, the Accelerometer and Gyroscope bindings of the "Motion Input" tab should be already populated with the matching axles from the DSU Server.

If they are blank (e.g. the current controller configuration was created by an older Dolphin version), you can manually assign the corresponding motion axles by right-clicking each binding and picking the corresponding axis on the end of the list or you can simply click on the Default button in the main window (but keep in mind this will reset all bindings in all tabs).

Alternatively, you can completely skip the setup of a DSU Server/Client and directly assign the motion sensor axles of most controllers by selecting the corresponding evdev/x/xxxx entry on the Devices drop-down menu on Linux (or SDL/x/xxxx on Windows and macOS), thanks to the evdev and SDL APIs natively exposing motion axles.

Emulated pointer

On Dolphin 5.0-11083 and newer, if the Accelerometer and Gyroscope bindings of the "Motion Input" tab of Emulated Wii Remotes are assigned correctly, the Wii Remote IR Pointer position will be derived from the motion sensors, thus dispensing the need for a sensor bar. To fine-tune the emulated pointer, you can assign a button to recenter the cursor when pressed and can also adjust the maximum rotation of the yaw axis through the bindings present on the "Point" section in the "Motion Input" tab of Emulated Wii Remotes. Also, starting with Dolphin 5.0-11205, this feature can be manually disabled in case you still want to map the IR Pointer through the bindings of the "Motion Simulation" tab.

Troubleshooting

DSUClient/x/xxxx entries doesn't appear on Dolphin's Devices list

Assuming you've set up your DSU Server correctly, here's a common checklist:

  • Is the DSU Server running?
  • Did you enable the DSU Client in Dolphin?
  • Did you specify the correct server IP Address and server port in Dolphin?
  • Have you checked if both the DSU Server application and Dolphin are whitelisted on your OS firewall?

Additionally, on Windows, you can use the DSU Pad Test application to check if the DSU Server is communicating correctly. If no devices are detected on the DSU Pad Test, you should check your DSU Server settings before trying to use the input devices with Dolphin.

I can't reach the left/right sides of the screen with the emulated pointer

Increasing "Total Yaw" on the Motion Input tab of Emulated Wii Remotes should fix that. Keep in mind there isn't a correct value as the amount of yaw needed for the emulated pointer reach both sides of the screen varies a lot between different games, so finding a value that works with all games is somewhat impossible.

My controller has rumble support but I can't map it when using DSU Client

Since the DSU protocol doesn't carry rumble data, that's expected. Fortunately, most DSU Servers will also assign a virtual XInput device for every real controller connected to them, so you can map the rumble through this virtual device. To do that, right click the "Motor" binding on Emulated GameCube Controller or Emulated Wii Remote settings and select the appropriate XInput device in the dropdown list.

I'm using a DualShock 3 controller and button presses only register if I press the buttons hard

With the exception of the Start, Select, PS, L3 and R3, all DualShock 3 buttons are pressure sensitive. Different from the common input APIs, the amount of pressure being applied to each button is reported back to Dolphin as full analog buttons when accessing DualShock 3 controllers through DSU protocol.

By default, Dolphin will register analog buttons as "pressed" when at least 50% of force is applied to them, but users can fine-tune that threshold individually by right-clicking each binding and adjusting the "Range" slider. For instance, setting the range to 200 will register the buttons as pressed when 25% of force is applied to them, and that value seems to provide a button press feedback very close of other controllers with digital-only face buttons (e.g. DualShock 4, Xbox, Joy-Con, Pro Controller, etc).