path: root/README.md

# Brokenithm-Evolved-iOS-Umi
A version of [esterTion/Brokenithm-iOS](https://github.com/esterTion/Brokenithm-iOS) but maps inputs to keybinds and has support for slider LEDs based on the [Umiguri LED Controller Protocol](https://gist.github.com/inonote/00251fed881a82c9df1e505eef1722bc)

[![Demo](https://files.catbox.moe/w3564o.png)](https://files.catbox.moe/oz9kos.mp4)

This app only works while connected via USB to the PC (this significantly reduces input latency while the router is congested). Use [slidershim](https://github.com/4yn/slidershim) if you are looking for a wireless solution.

# Usage
You will should first download an iOS client/app. Some options are listed below:
- [OWCramer/Brokenithm-SwiftUI](https://github.com/OWCramer/Brokenithm-SwiftUI) - Build from source and sideload the IPA or Join the TestFlight on the README
- [esterTion/Brokenithm-iOS](https://github.com/esterTion/Brokenithm-iOS) - Build from source or download the IPA [here](https://redive.estertion.win/ipas/Brokenithm-iOS-build-10.ipa) ([backup](https://files.catbox.moe/3zhhn2.ipa)) then sideload

Download the latest built version from Releases. Extract the files into some folder, you should keep all the files in the ZIP together.

Run `Brokenithnm-Evolved-iOS-Umi.exe`

> [!IMPORTANT]  
> You must launch the server before Umiguri. If Umiguri is already opened you will need to restart the game