diff --git a/README.md b/README.md index e007fda..9a869b0 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,4 @@ -

- -

+# BetterJoy v6.1 - DS4 Gyro +This is an experimental branch of BetterJoy that uses a custom build of ViGEm to allow the use of DS4 gyro/accel controls. For more info, please see [the following wiki page](https://github.com/Davidobot/BetterJoy/wiki/DS4-Gyro). -# BetterJoy v6 -Allows the Nintendo Switch Pro Controller, Joycons, and Switch SNES controller to be used with [Cemu](http://cemu.info/) using [Cemuhook](https://sshnuke.net/cemuhook/), [Citra](https://citra-emu.org/), [Dolphin](https://dolphin-emu.org/), and system-wide with generic XInput support. - -It also allows using the gyro to control your mouse and remap the special buttons (SL, SR, Capture) to key bindings of your choice. - -If anyone would like to donate (for whatever reason), [you can do so here](https://www.paypal.me/DavidKhachaturov/5). - -#### Personal note -Thank you for using my software and all the constructive feedback I've been getting about it. I started writing this project a while back and have since then learnt a lot more about programming and software development in general. I don't have too much time to work on this project, but I will try to fix bugs when and if they arise. Thank you for your patience in that regard too! - -It's been quite a wild ride, with nearly 110k official download on GitHub and probably many more through the nightlies. I think this project was responsible for both software jobs I landed so far, so I am quite proud of it. - -### Screenshot -![Example](https://user-images.githubusercontent.com/16619943/67919451-bf8e5680-fb76-11e9-995e-7193b87548e1.png) - -# How to use -1. Install drivers - 1. Run *! Driver Install (Run as Admin).bat* -2. Run BetterJoyForCemu.exe -3. Connect your controllers. -4. 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. -5. 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** - 2. Turn rumble up to 70-80% if you want rumble. - -* As of version 3, you can use the pro controller and Joycons as normal xbox controllers on your PC - try it with Steam! - -# More Info -Check out the [wiki](https://github.com/Davidobot/BetterJoy/wiki)! There, you'll find all sorts of goodness such as the changelog, description of app settings, the FAQ and Problems page, and info on how to make BetterJoy work with Steam *better*. - -# Connecting and Disconnecting the Controller -## Bluetooth Mode - * Hold down the small button (sync) on the top of the controller for 5 seconds - this puts the controller into broadcasting mode. - * Search for it in your bluetooth settings and pair normally. - * To disconnect the controller - press the sync button once. To reconnect - press any button on your controller. - -## USB Mode - * Plug the controller into your computer. - -## Disconnecting \[Windows 10] -1. Go into "Bluetooth and other devices settings" -1. Under the first category "Mouse, keyboard, & pen", there should be the pro controller. -1. Click on it and a "Remove" button will be revealed. -1. Press the "Remove" button - -# Acknowledgements -A massive thanks goes out to [rajkosto](https://github.com/rajkosto/) for putting up with 17 emails and replying very quickly to my silly queries. The UDP server is also mostly taken from his [ScpToolkit](https://github.com/rajkosto/ScpToolkit) repo. - -Also I am very grateful to [mfosse](https://github.com/mfosse/JoyCon-Driver) for pointing me in the right direction and to [Looking-Glass](https://github.com/Looking-Glass/JoyconLib) without whom I would not be able to figure anything out. (being honest here - the joycon code is his) - -Many thanks to [nefarius](https://github.com/ViGEm/ViGEmBus) for his ViGEm project! Apologies and appreciation go out to [epigramx](https://github.com/epigramx), creator of *WiimoteHook*, for giving me the driver idea and for letting me keep using his installation batch script even though I took it without permission. Thanks go out to [MTCKC](https://github.com/MTCKC/ProconXInput) for inspiration and batch files. - -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! - -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/). [Super Nintendo Controller](https://thenounproject.com/themizarkshow/collection/vectogram/?i=193592) icon by Mark Davis from the [the Noun Project](http://thenounproject.com/); icon modified by [Amy Alexander](https://www.linkedin.com/in/-amy-alexander/). +I will merge this branch into master once ViGEm updates to include the gyro API (we're working on it)