CitraTouchControl

CitraTouchControl offers a multi touch able onscreen overlay for the Nintendo 3DS Emulator Citra.

This is useful for remote play sessions with Citra from a mobile device or if you just do not want to sit in front of your PC to play.

It will auto adjust to match Citra position and size, onscreen controls' keys can be modified and touch/controls can be toggled on and off.

It further features "savegame/bookmark replacement"; a very basic savestate system. Only useful in games which allow you to create bookmarks like Fire Emblem. Create a bookmark, save it via CitraTouchControl, overwrite it and load it back in the case you screw up later.

See it in Action

Requirements

• Citra-Qt build (grab the latest canary build here)
• Windows PC with Aero (Windows 7 or later) which runs Citra at decent (>30) framerates
• Mobile device that can handle a massive input network-stream
• Fast (>75Mbps) network connection between the host-PC and your mobile device (ideally PC -> LAN -> Router -> 5G WLAN -> Mobile device)

Usage

1. Start Citra and load up your game.
2. Connect to your host-PC via the Remote Desktop app on your mobile device.
3. Start CitraTouchControl via remote control, lower KeyPress duration according to your network delay.
4. Enjoy playing 3DS games on your tablet/phone.

Configuration

1. Enable RDP on your host PC
   • Make sure services "TermService" and "SessionEnv" are running and restart your PC if you encounter any problems
   • Some Antivirus solutions like Kaspersky may interfere even with local RD sessions
2. Optimize RDP data usage via the Group Policy Editor
   1. Start -> Run -> "gpedit.msc"
   2. Navigate to "Computer Configuration -> Administrative Templates -> Windows Components -> Remote Desktop Services -> Remote Desktop Session Host -> Remote Session Environment"
   3. Set the following entries:
      • "Limit maximum color depth": Enabled, 24bit
      • "Enforce Removal of Remote Desktop wallpaper": Enabled
      • "Configure H.264/AVC hardware encoding for Remote Desktop connections": Enabled, Always attempt (most important)
      • "Configure compression for RemoteFX data": Enabled, Optimized to use less network bandwidth
      • "Configure Image Quality For RemoteFx Adaptive Graphics": Enabled, Medium
      • "Configure RemoteFX Adaptive Graphics": Enabled, Optimize for minimal bandwidth usage
3. Start Citra and CitraTouchControl, press the menu button on CitraTouchControl (bottom one) to bring up the configuration menu
   1. Press "Configure Keys" to bring up the next window and set all your controls there
   2. Lower KeyPress delay according to your network delay
4. Install Microsoft Remote Desktop Beta on your mobile device
5. Start it and add a new Desktop connection to your host PC
   1. Insert the local IP and Windows credentials of your host PC
   2. Enable "Custom display resolution" and set it to the lowest one available (100% scaling)
   3. If you want sound, then set Sound to "Play sound on device" (this will require additional bandwidth)
   4. On the first connection press the menu button of the app (the one in the top bar with the 3 lines) and enable Touch in the fly-in-window on the right

Options

• Save Savegames: zips up all current savegames. Use this if you want to back up bookmarks/saves before overwriting them.
• Load Savegames: loads all previously zipped savegames/bookmarks back into Citra. Use this if you want to go back to a previous one.
• Reload Overlay: will reset the overlay. Use this if the overlay is off or buttons don't work anymore.
• Enable Touch: will make the overlay "click through" (buttons will still work).
• Hide controls: will remove all controls except the menu button from the overlay. Use this and enabled touch for a stylus like experience.
• Touch: Tap only: will make all onscreen buttons "static". If you press a button, it will send KeyDown and KeyUp. Holding a button will not send multiple keystrokes anymore. Use this if you encounter involuntary KeyPresses (mostly due to lag).
• Keypress: adjust the duration a Key keeps being pressed after you removed your finger from the button. Reduce this if you encounter involuntary KeyPresses (mostly due to lag) or increase it if buttons are not recognized anymore.
• Configure Keys: set keys for all onscreen controls (only works with a physical keyboard, will not work over RDP from a mobile device)

Tested Remote Desktop Apps

Contributing

If you find any Remote Desktop App which is fast enough for this kind of usage and supports portrait mode (also applies for other platforms like iOS or Windows Phone) then please let me know. Either send me a mail or create an issue here.

Limitations

• Due to the fact that Microsofts RDP display driver does not support OpenGL 3.3 Citra will not work if you start it over an RDP-session. Start Citra and load your game BEFORE you connect via RDP.
• If your connection drops it may be possible that CitraTouchControl will freeze. Manually close and reopen it.
• Configuring keys only works with a physical keyboard; it will not work via Remote Desktop from a mobile device.
• Onscreen controls react to touch only, mouseclicks will not work (menu button is the exception).
• If the Windows Scaling Option is set to anything else than 100% the overlay will be off, however you don't have to change your default scaling because an RDP session uses its own scaling.
• Loading savegames only affect games that check saves on the fly. Some games may require a full reload (Citra -> File -> Load File...) afterwards.
• Overlay only checks for a process called "citra-qt.exe". If your build of Citra is called something else, then you'll have to rename it.
• Overlay will not adjust itself after startup. Use the "Reload Overlay" option in menu if you move/resize Citra later.
• Overlay will not detect a restart of Citra. You will have to restart CitraTouchControl manually if you close and reopen Citra.
• If Citra runs in admin mode you'll have to start CitraTouchControl as admin too.
• If your connection has lag >50ms CitraTouchControl will eventually hold KeyDown for too long which will result in recognition of multiple KeyPresses. Try the "Touch: Tap only" option in menu or reduce the KeyPress duration to ~20ms.