Add FAQ section
This commit is contained in:
parent
67193755d8
commit
ae101d6e8f
1 changed files with 23 additions and 7 deletions
30
README.md
30
README.md
|
@ -2,10 +2,10 @@
|
|||
|
||||
![image](https://user-images.githubusercontent.com/96280/163298419-6279f338-069e-4302-971f-b9d2e5fc9f7a.png)
|
||||
|
||||
# How does it work?
|
||||
## How does it work?
|
||||
It pretends to be the [Just Dance Controller app](https://play.google.com/store/apps/details?id=com.ubisoft.dance.justdance2015companion), sends movements of the Joy-Con to your game console.
|
||||
|
||||
# Features
|
||||
## Features
|
||||
- Play Just Dance 2017 and later on Xbox/Stadia/PS/NSW with Joy-Cons.
|
||||
- Playing with a Joy-Con (+ its strap) is safer and more comfortable than holding a phone.
|
||||
- No latency.
|
||||
|
@ -19,14 +19,14 @@ It pretends to be the [Just Dance Controller app](https://play.google.com/store/
|
|||
- Stadia (not tested)
|
||||
- Playstation 4/5 (not tested)
|
||||
|
||||
# Tested on
|
||||
## Tested on
|
||||
- JD 2022 on Xbox Series X and JD 2020 on Nintendo Switch.
|
||||
- MacOS Catalina 10.15 with [TP-Link Bluetooth 4.0 Nano USB Adapter UB400](https://www.tp-link.com/us/home-networking/usb-adapter/ub400/).
|
||||
- Raspberry Pi Zero 2 W with [MPOW BH519A Bluetooth 5.1 USB Adapter](https://www.xmpow.com/products/mpow-bh519a-bluetooth-5-1-usb-adapter-for-pc).
|
||||
|
||||
Tested on Zero 2 W with 2 Joy-Cons and it worked just fine.
|
||||
|
||||
# Requirements
|
||||
## Requirements
|
||||
- PC/Mac/Linux with bluetooth support.
|
||||
- [Python 3.7+](https://www.python.org) and [pip](https://pip.pypa.io/en/stable/installation/) installed.
|
||||
- 1 to 6 Joy-Cons.
|
||||
|
@ -34,14 +34,14 @@ Tested on Zero 2 W with 2 Joy-Cons and it worked just fine.
|
|||
- Use a Bluetooth dongle, because built-in Bluetooth sucks (or you will get disconnected constantly while playing). Make sure you buy a dongle with game controllers support, not just for audio devices. Not all dongles support Mac/Linux, so remember to check compatibility before buying.
|
||||
- Use a Nintendo Switch to update Joy-Con to the latest firmware & calibate its motion sensors. Ask your friends or bring it to the game shop if you don't have one.
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
1. Download the latest version and extract it into a folder.
|
||||
2. Open that folder in Terminal/Command Prompt, then run this command:
|
||||
```
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
### Extra steps for Linux users
|
||||
#### Extra steps for Linux users
|
||||
|
||||
1. Linux users may need to use [`hid`](https://github.com/apmorton/pyhidapi) instead of [`hidapi`](https://github.com/trezor/cython-hidapi) (not sure why `hidapi` couldn't find Joy-Cons on Linux).
|
||||
```
|
||||
|
@ -75,7 +75,7 @@ sudo udevadm trigger
|
|||
|
||||
3. Install [`dkms-hid-nintendo`](https://github.com/nicman23/dkms-hid-nintendo) (Joy-Con driver) if you're running Linux kernel older than 5.16.
|
||||
|
||||
# Usage
|
||||
## Usage
|
||||
|
||||
1. Open the phone pairing screen on Just Dance.
|
||||
|
||||
|
@ -114,3 +114,19 @@ sudo udevadm trigger
|
|||
7. Press the "Connect" button next to Joy-Con to start the pairing process.
|
||||
|
||||
8. 💃🕺
|
||||
|
||||
## FAQ
|
||||
1. **What is the correct way to hold a Joy-Con?**
|
||||
Hold the Joy-Con (L)/(R) in your right hand, with your palm touching the back of Joy-Con.
|
||||
|
||||
2. **How to control with Joy-Con (L)?**
|
||||
- Up = X
|
||||
- Right = A
|
||||
- Down = B
|
||||
- Left = Y
|
||||
- L = R
|
||||
- ZL = ZR
|
||||
- Minus = Plus
|
||||
|
||||
3. **How to exit JoyDance?**
|
||||
Press `Ctrl + C` two times or close the Terminal window.
|
||||
|
|
Loading…
Reference in a new issue