Create README.md

This commit is contained in:
redphx 2022-04-14 09:00:07 +07:00 committed by GitHub
commit 10fa9c8aa9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 0 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# JoyDance
![image](https://user-images.githubusercontent.com/96280/163298419-6279f338-069e-4302-971f-b9d2e5fc9f7a.png)
# Features
- Play Just Dance 2017 and later on Xbox/Stadia/PS/NSW with Joy-Cons.
- No latency.
- Better score than using a phone.
- Support up to 6 players.
- Support all platforms (in theory):
- Xbox Series X/S
- Nintendo Switch
- Xbox One (not tested)
- Stadia (not tested)
- Playstation 4/5 (not tested)
# Requirements
- [Python 3.7+](https://www.python.org) and [pip](https://pip.pypa.io/en/stable/installation/) installed.
- PC/Mac/Linux.
- Bluetooth dongle (because built-in bluetooth sucks).
- 1 to 6 Joy-Cons. It's RECOMMENED to update Joy-Cons to the latest firmware version & calibrate motion sensors using a Nintendo Switch first (ask your friends or bring it to the game shop if you don't have one).
# 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 for PC](https://www.xmpow.com/products/mpow-bh519a-bluetooth-5-1-usb-adapter).
Tested on Zero 2 W with 2 Joy-Cons and it worked just fine.
# Installation
...
# How to use
...