empathicqubit/BetterJoy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
David Khachaturov 2018-08-23 16:57:48 +03:00 • committed by GitHub
parent 68b6928d86
commit af21ac1cfe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,13 +1,21 @@
# BetterJoyForCemu v4
Allows the Nintendo Switch Pro Controller to be used with the [Cemu Emulator](http://cemu.info/) and [Cemuhook](https://sshnuke.net/cemuhook/).
__Note that this program allows the Pro Controller and Joycons to be used system-wide without installation of Cemu - just follow the *How to Use* instructions until point 3__
So there has been a recent increase in interest in the program due to Citra now supporting native gyro in the canary builds. I'll be back to working on BetterJoyForCemu starting next week and version 5 should be out by the 20th.
# BetterJoyForCemu v5
Allows the Nintendo Switch Pro Controller and Joycons to be used with [Cemu](http://cemu.info/) using [Cemuhook](https://sshnuke.net/cemuhook/), [Citra](https://citra-emu.org/), and system-wide with generic XInput support.
If anyone would like to donate (for whatever reason), [you can do so here](https://www.paypal.me/DavidKhachaturov/5).
# Changelog
### v5
* Progressive scanning
* You can keep BetterJoyForCemu running and just connect controllers to your PC - it will detect them.
* UI rework
* Buttons for locating controllers through vibration
* Click on the joycon controller buttons to **toggle single/joint Joycon mode**.
* Improved rumble
* Added options to turn off HidGuardian and XInput emulation
* Allows BetterJoy to be used exclusively for gyro (for example when using Citra + Steam)
* Improved driver install batch files (thanks BetaLeaf)
* General system stability improvements to enhance the user's experience
### v4
* Implemented a GUI
* Added application icon
@ -53,26 +61,25 @@ If anyone would like to donate (for whatever reason), [you can do so here](https
* Initial release
# How to use
1. Connect pro controller via bluetooth/usb
1. Install drivers
1. Run *! Driver Install (Run as Admin).bat*
1. Run BetterJoyForCemu.exe
1. If the controller recongised, the first LED should light up.
1. If running for the first time, things might glitch out - just close BetterJoyForCemu normally and restart your computer for the drivers to take effect.
1. If not, see the __Problems__ section.
1. Minimise BetterJoyForCemu.
1. Connect your controllers.
1. Start Cemu and ensure CemuHook has the controller selected.
1. If using Joycons, CemuHook will detect two controllers - each will give all buttons, but choosing one over the other just chooses preference for which hand to use for gyro controls.
1. Go into *Input Settings*, choose XInput as a source and assign buttons normally.
1. If you don't want to do this for some reason, just have one input profile set up with *Wii U Gamepad* as the controller and enable "Also use for buttons/axes" under *GamePad motion source*. **This is no longer required as of version 3**
1. Turn rumble up to 70-80% if you want rumble.
1. Please press enter in the console box once you're done with the program - closing it by clicking "x" does not stop the services correctly.
* As of version 3, you can use the pro controller and Joycons as normal xbox controllers on your PC - try it with Steam!
# App Settings
Feel free to edit *BetterJoyForCemu.exe.config* before running the program to configure it to your liking.
For example, for use with [Citra and Steam simultaneously](https://community.citra-emu.org/t/improvements-to-motion-control/42125), you may consider turning off *UseHIDG* and *ShowAsXInput*.
Current settings are:
* IP address of CemuHook motion server *(default: 127.0.0.1)*
* Port number of CemuHook motion server *(default: 26760)*
@ -84,6 +91,10 @@ Current settings are:
* Swaps the A-B and X-Y buttons to mimick the Xbox layout by button name, rather than physical layout
* PurgeWhitelist *(default: true)*
* Determines whether or not HidGuardian's process whitelist is purged on start-up
* UseHIDG *(default: true)*
* Determines whether or not to use HidGuardian (improves compatibility with other programs, like Steam, when set to "false")
* ShowAsXInput *(default: true)*
* Determines whether or not the program will expose detected controllers as Xbox 360 controllers
# Problems
__Make sure you installed the drivers!!__
@ -151,4 +162,5 @@ Many thanks to [nefarius](https://github.com/nefarius/ViGEm) for his ViGEm proje
A last thanks goes out to [dekuNukem](https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering) for his documentation, especially on the SPI calibration data and the IMU sensor notes!
Icon (modified): "[Switch Pro Controller](https://thenounproject.com/term/nintendo-switch/930119/)" icon by Chad Remsing from [the Noun Project](http://thenounproject.com/).
Icons (modified): "[Switch Pro Controller](https://thenounproject.com/term/nintendo-switch/930119/)", "[
Switch Detachable Controller Left](https://thenounproject.com/remsing/uploads/?i=930115)", "[Switch Detachable Controller Right](https://thenounproject.com/remsing/uploads/?i=930121)" icons by Chad Remsing from [the Noun Project](http://thenounproject.com/).