diff --git a/wiki-rtd/docs/wiki_controllers/nintendo/joycon.md b/wiki-rtd/docs/wiki_controllers/nintendo/joycon.md index 48fbf23..e59c98b 100644 --- a/wiki-rtd/docs/wiki_controllers/nintendo/joycon.md +++ b/wiki-rtd/docs/wiki_controllers/nintendo/joycon.md @@ -1,175 +1,17 @@ -# Nintendo Controllers +# Joy-Cons -Nintendo Controllers are controllers made by the company Nintendo.
-**Motion Controllers** made by Nintendo are listed under the Motion Controllers entry on the wiki. - -**Note some these inputs are part of the upcoming 0.8b update.** - -## Switch Pro - - - -Official Controller for the Nintendo Switch - -#### Steam Input support -Yes - - -#### Linux Kernel Support -Yes, since 5.16 - `hid-nintendo` - -### What is the Official - Switch Pro RetroDECK profile called? - -- Switch Pro Controller: `RetroDECK: Switch Pro` - -#### What is the Current Version Number of the profile? - -WIP - -#### Switch Pro - Global Hotkeys: Nintendo Button Combos - -The global hotkeys are activated by pressing the `SELECT` button and holding it while pressing the corresponding other button input. -What follows is a list of hotkeys: - -`Function` Shows what the hotkey does.
-`Button / Combination` Shows the input you need to make to trigger the command.
-`Command` Shows what is being sent to the emulator.
-`Emulator Support` Shows what emulators support the command.
-`Comment` Just extra comments.
- - -| Function | Button / Combination| Command | Emulator Support | Comment | -| :--- | :---: | :---: | :---: | :---: | -| Pause / Resume | `SELECT + B` | `CTRL + P` | `RetroArch` `Citra` `Dolphin/Primehack` `Duckstation` `MelonDS` `PCSX2` `Yuzu` | | -| Take Screenshot | `SELECT + A` | `CTRL + X` | `RetroArch` `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2` `Yuzu` | | -| Fullscreen Toggle | `SELECT + Y` | `CTRL + ENTER` | `Citra` `Dolphin/Primehack` `Duckstation` `MelonDS` `PCSX2` `Yuzu` | | -| Open Menu | `SELECT + X` | `CTRL + M` | `RetroArch` `Duckstation` `PCSX2` `Yuzu` | -| Quit Emulator | `SELECT + Start` | `CTRL + Q` |`RetroArch` `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2` `Yuzu` | | | -| Previous State Slot | `SELECT + D-Pad Left` | `CTRL + J` | `RetroArch` `Dolphin/Primehack` `Duckstation` `PCSX2`| | | -| Next State Slot | `SELECT + D-Pad Right` | `CTRL + K` | `RetroArch` `Dolphin/Primehack` `Duckstation` `PCSX2`| -| Increase Emulation Speed | `SELECT + D-Pad Up` | `CTRL + 1` | `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2`| | | -| Decrease Emulation Speed | `SELECT + D-Pad Down` | `CTRL + 2` | `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2`| | | -| Load State | `SELECT + L1` | `CTRL + A` | `RetroArch` `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2` | | -| Save State | `SELECT + R1` | `CTRL + S` | `RetroArch` `Citra` `Dolphin/Primehack` `Duckstation` `PCSX2` | | -| Rewind | `SELECT + L2` | `CTRL + -` | `RetroArch` `Duckstation` | | -| Fast forward | `SELECT + R2` | `CTRL + +` | `RetroArch` `Duckstation` `MelonDS` `PCSX2` | | -| Global Radial Menu | `SELECT + Left Joystick` | | Opens the Radial Menu | - -### Global Radial Menu - -The Global Radial Menu is activated by holding `SELECT` and by moving the `Left Joystick`, then by pressing `L3` allows you press the selected radial button. - -Radial Button | Keyboard Command| Emulator Support | Comment | -| :--- | :---: | :---: | :---: | -| Space | `Space` | `PC-Systems` | | -| Escape | `Escape` | `PPSSPP` `PC-Systems` | On PPPSPP it opens the Menu | -| Enter | `Enter` | `OpenBOR` `PC-Systems` | | -| F1 | `F1` | `PC-Systems` | | -| F5 | `F5` | `PC-Systems` | | -| F10 | `F10` | `PC-Systems` | | -| Wii Sync Button | `ALT + W` | `Dolphin/Primehack` | | -| Swap Dual-Screens | `CTRL + TAB` | `RetroArch` `Citra` `MelonDS` `Cemu`| | -| Change Dual-Screen Layout | `CTRL + L` | `Citra` | | -| Widescreen / Aspect Ratio | `CTRL + W` | `Dolphin/Primehack` `Duckstation` `PCSX2` | | -| Fullscreen Toggle | `CTRL + ENTER` | `Citra` `Dolphin/Primehack` `Duckstation` `MelonDS` `PCSX2` `Yuzu` | | -| Change Disc / Next Disc | `CTRL + D` | `RetroArch` `Dolphin/Primehack` `Duckstation`| | - - -### Right Joystick as Temporary Mouse - -By holding `SELECT` and moving the `Right Joystick` you can use it as a mouse for various systems that uses mouse input. - -| Function | Button / Combination| Command | Comment | -| :--- | :---: | :---: | :---: | -| Joystick as Mouse | `SELECT + Right Stick` | | Movement | -| Right Click | `SELECT + L3` | `Right Click` | | -| Left Click | `SELECT + R3` | `Left Click` | | - -### RetroArch: Additional Hotkeys - -These hotkeys also work for RetroArch and are built in. - -| Function | Button / Combination | Emulator Support | Comment | -| :--- | :---: | :---: | :---: | -| Open Menu | `L3 + R3` | `RetroArch` | | - -### Arcade Systems: Additional Hotkeys - -This hotkey work for RetroArch, MAME, FBNEO and other arcade systems. - -| Function | Button / Combination | Emulator Support | Comment | -| :--- | :---: | :---: | :---: | -| Insert Credit | `SELECT` | `RetroArch` `MAME` `FBNeo` | | - -## Joy-Cons - - + Official Controllers for the Nintendo Switch -#### Steam Input support +### Steam Input support Yes -#### Linux Kernel Support +### Linux Kernel Support Yes, since 5.16 - `hid-nintendo` ### What is the Official - Switch Pro RetroDECK profile called? - Switch Pro: `RetroDECK: Switch Joycons` -Note that this will be released at a later date and work has not started on it yet. - -## Wii U GamePad - - - -Official Controller for the Wii U - -#### Steam Input support -No - -#### Linux Kernel Support -No - -A list of projects and drivers that try to make the Wii U controller work on Linux. - -[libdrc](https://github.com/rolandoislas/libdrc) - -There has been efforts of adding by the libdrc team of add their `hid-wiiu-drc` to the Linux Kernel.
- -[linux-wiiu](https://gitlab.com/linux-wiiu/linux-wiiu) - -Is a Linux distro that can be used on the Wii U machine. This seams to have a working `hid-wiiu-drc` -But the efforts to add it to the kernel seams to have been stalled. - -[hid-wiiu-drc in linux-wiiu](https://gitlab.com/linux-wiiu/linux-wiiu/-/blob/rewrite-4.19/drivers/hid/hid-wiiu-drc.c) - -[LWN Discussion on hid-nintendo-wiiu](https://lwn.net/ml/linux-kernel/20211027101043.31609-6-linkmauve@linkmauve.fr/) - - -## GameCube Controller Adapter for Wii U - -#### Steam Input support -Yes, but the connected controllers shows up as Generic Controllers - -#### Linux Kernel Support -Yes, acts a normal USB-hub. - -### How to connect? - -In most cases you just need to connect it via USB and put the device in PC mode on the switch. - -Sometimes the udev rule is missing and you will need to add it: - -1. Open a terminal window -2. Type `sudo echo 'SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="0337", MODE="0666"' | sudo tee -a /etc/udev/rules.d/51-gcadapter.rules > /dev/null` -3. Type `sudo udevadm control --reload-rules` -4. Sometimes you will need to take out and reinsert the USB connector after you have reloaded the rules. - - - -### What is the Official - Switch Pro RetroDECK profile called? - -- Switch Pro: `RetroDECK: Generic GameCube` - -NOTE: That this will be released at a later date and work has not started on it yet. +NOTE: This will be released at a later date and work has not started on it yet. diff --git a/wiki-rtd/docs/wiki_controllers/nintendo/wii-remote.md b/wiki-rtd/docs/wiki_controllers/nintendo/wii-remote.md new file mode 100644 index 0000000..620173c --- /dev/null +++ b/wiki-rtd/docs/wiki_controllers/nintendo/wii-remote.md @@ -0,0 +1,169 @@ +# Wii Remote (Wiimote) & Nunchuck + + + +The main input for the Nintendo Wii. + +### Steam Input Support +No + +### Linux Kernel Support +Yes, since 3.1 - `hid-wiimote` + +### Emulator usecase +Dolphin + +### Information: On third party Wiimotes + +Many 3rd party Wiimotes do not have native Linux support this is being worked on a higher level. +If you own or want to try them in RetroDECK and you should know that: + +- Sometimes they will work with Bluetooth Passthrough mode in Dolphin (read more on this page). +- Sometimes they will be remember the paring to the Bluetooth adapter while other times they will not and needs to be synced for every game. + +**Sources:** + +[xwiimote github](https://github.com/xwiimote/xwiimote) + +[xwiimote-ng github](https://github.com/dev-0x7C6/xwiimote-ng) - Fork of xwiimote + +**Related Issues:** + +[xwiimote: issue 66](https://github.com/xwiimote/xwiimote/issues/66) + +[xwiimote: issue 73](https://github.com/xwiimote/xwiimote/issues/73) + +[bluez: issue 94](https://github.com/bluez/bluez/issues/94) + + + +### Mod: Wii bluetooth adapter to USB + +For those people that really likes to do hardware mods it is possible to buy the bluetooth adapter spare part from a Wii console and wire it as an USB bluetooth adapter. + +Read more here: + +[How to wire a Wii's Bluetooth Module to a PC USB Port](https://forums.dolphin-emu.org/Thread-how-to-wire-a-wii-s-bluetooth-module-to-a-pc-usb-port) + +### Steam Deck Tips: + +The recommended method of playing is docked connected to a monitor/tv and to have a separate Bluetooth dongle attached to the dock. + +- You need to have set a sudo password for the Steam Deck. + +- It can be helpful to have a Keyboard / Mouse connected to the dock while setting everything up. + +- It is good to sit close to the Steam Deck when paring the Wiimotes. + +- As of now it is easier to configure Wiimotes in `Desktop Mode` then transfer over to `Game Mode` when everything is working (we will make easier tools later in the Configurator). + - Open up Dolphin by launching it from the stand alone Configurator. + - Make all the settings changes to connect the Wiimotes from the methods here on this page. + - Try to launch a game from `Desktop Mode` directly in Dolphin by clicking on a game in the Dolphin interface. + - If the paring works, the Wiimotes connects and the game controls fine with the Wiimotes in `Desktop Mode` it will as intended in `Game Mode` when launched from RetroDECK. + + +#### RetroDECK Sync Wiimote Hotkey + +RetorDECK has a built-in hotkey for pressing the Dolphins `Sync Wiimote` button `Alt + W` if you find yourself disconnected.
+It can also be accessed from some controllers radial menu systems on for example the Steam Deck. + +--- + +## Dolphin + +#### Hardware Prerequisites for Dolphin: + + + +- A Wii Sensor Bar alternative that can be wireless or wired. + + + +- At least one Linux compatible Bluetooth dongle or built-in Bluetooth adapter. + +### How-to configure Dolphin - Method: Bluetooth Connection + +This only works with the Official Wiimote controller and is the easier method. + +WIP + +--- + + +### How-to configure Dolphin - Method: Bluetooth Passthrough + +This works with both 3rd party and official Wiimotes. It is a harder method with some downsides. + +**🛑 Warning 🛑**
+ +This method will make the Bluetooth adapters unusable for other devices while playing Wii Games and not other devices can connect to it except Wiimotes, that means all other devices will disconnect. +It could be good to have a second input method as backup like a wireless keyboard dongle connected. + + +Source: [Dolphin Wiki: Bluetooth_Passthrough](https://wiki.dolphin-emu.org/index.php?title=Bluetooth_Passthrough) + +#### Step 1: Find your Vendor and Product ID's + +First you need to find our your `Vendor ID` `Product ID` for the Bluetooth adapter you want to use. + +1. Open a terminal window +2. Type `lsusb` +3. It will now display all connected USB or BUS devices that you have connected. Example: + +``` +Bus 001 Device 003: ID 0bda:5650 Realtek Semiconductor Corp. +Bus 001 Device 004: ID 8087:0025 Intel Corp. Wireless-AC 9260 Bluetooth Adapter +``` + +`ID 8087:0025 Intel Corp. Wireless-AC 9260 Bluetooth Adapter` is the Bluetooth Adapter in this example. + +The `ID 8087:0025` left value is the `Vendor ID` while the right is `Product ID`.
+Thus in this example: `Vendor ID` is `8087`:`Product ID` is `0025`. + +#### Step 2: Create the rules file + +You will need root privlages for this. + +Open a terminal and type the following command and replace `Vendor ID` and `Product ID` respectively.: + +`sudo echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="Vendor ID", ATTRS{idProduct}=="Product ID", TAG+="uaccess"' | sudo tee -a /etc/udev/rules.d/52-dolphin.rules > /dev/null` + +from the example above the result should look like this: + +`sudo echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="8087", ATTRS{idProduct}=="0025", TAG+="uaccess"' | sudo tee -a /etc/udev/rules.d/52-dolphin.rules > /dev/null` + +2. Reload udev rules with: `sudo udevadm control --reload-rules` +3. Take out and reinsert the Bluetooth adapter or reboot if a built-in was used. + +#### Step 3: Enable Bluetooth Passthrough in Dolphin + +Open `RetroDECK Configurator` -> `Open Emulator` -> `Dolphin` -> `Options` -> `Controller Settings` + + + +Change Bluetooth type: + +- From `Emulate the Wii's Bluetooth adapter` to `Passthrough a Bluetooth Adapter` + +Enable the following checkboxes: + + + +- `Connect Wii Remotes for Emulated Controllers` +- `Continous Scanning` + +#### Step 4: Syncing the Wiimotes + +The Wiimote can now be connected when a game is launched, but it will not connect before that. +It will need to reconnect every time when launching a new game. + +You will need to `Sync Wiimote` by pressing `1` and `2` together on the Wiimote or the `Sync Button` (under the backplate), when launching a game. + +Sometimes you will also need to press the `Sync Button` on the Emulated Wii in the Dolphin Interface, this can be found in the controller menu in Dolphin or RetroDECK has a built in shortcut for this `Alt + W` that is also be accessed from the RetroDECK Radial Menu system on the Steam Deck while in `Game Mode` under Dolphin. + +#### Extra: Troubleshooting and tips + +- Always sit close to the device when you are doing the initial paring. +- Sometimes it can take a while before the paring happens, specially on 3rd party Wiimotes. You might need to try multiple times with both the `Sync Button` + `Sync Wiimote`. +- If you want to play with normal controllers as Wiimotes again the best way is to change back to: `Emulate the Wii's Bluetooth adapter` setting. +- If the udev rules you created in Step 2 are wrong and Dolphin can not get Bluetooth access, it will display a error message and crash. If that happens go back and make sure that the file in `/etc/udev/rules.d/52-dolphin.rules` and the content is correct. diff --git a/wiki-rtd/docs/wiki_controllers/nintendo/wiiu-gamepad.md b/wiki-rtd/docs/wiki_controllers/nintendo/wiiu-gamepad.md index 75c7086..b6b7ecb 100644 --- a/wiki-rtd/docs/wiki_controllers/nintendo/wiiu-gamepad.md +++ b/wiki-rtd/docs/wiki_controllers/nintendo/wiiu-gamepad.md @@ -1,6 +1,6 @@ # Wii U GamePad - + Official Controller for the Wii U diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 9c2cc4c..abe9aff 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -156,6 +156,7 @@ nav: - Switch - Pro Controller: wiki_controllers/nintendo/switch-pro.md - Switch - Joy-Cons: wiki_controllers/nintendo/joycon.md - Wii U - Gamepad: wiki_controllers/nintendo/wiiu-gamepad.md + - Wii - Wii Remote (Wiimote): wiki_controllers/nintendo/wii-remote.md - Gamecube - PC / WiiU Adapter: wiki_controllers/nintendo/gamecube-adapter.md - Controllers - Playstation :