diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-01-14 00:41:23 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-14 00:41:23 -0800 |
| commit | 8684f4fccf2b6acea3fda3124a9b7d4ec86ba72c (patch) | |
| tree | 8fc27ea75a26749eb979e8f6871e94f4ea4c0143 | |
| parent | bba427d31081f99b7dc5e724308ca6151753ccd1 (diff) | |
Create README.md
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..80919ed --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# 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) + +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` |