aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/README.md b/README.md
index 3534b10..d615614 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,22 @@
# 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]
-Allows you to use a wired Brokenithm connection with Umiguri and also get all the flashy lights
+A version of [esterTion/Brokenithm-iOS](https://github.com/esterTion/Brokenithm-iOS) but maps inputs to keybinds. Uses a WIRED connection with usbmux
-(https://gist.github.com/inonote/00251fed881a82c9df1e505eef1722bc)
+Has support for slider LEDs via websockets ([Umiguri LED Controller Protocol](https://gist.github.com/inonote/00251fed881a82c9df1e505eef1722bc)) so you can get glowy lights if its supported (port 7124)
[![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
+- [OWCramer/Brokenithm-SwiftUI](https://github.com/OWCramer/Brokenithm-SwiftUI) - Shown in demo image. Build from source and sideload the IPA OR Join the TestFlight on the repo's 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`
+Run `Brokenithm-Evolved-iOS-Umi.exe`
+
+**Ensure that UMIGURI is sending LED data on port 7124**
> [!IMPORTANT]
-> You must launch the server before Umiguri. If Umiguri is already opened you will need to restart the game
+> You must launch the server before Umiguri. If Umiguri is already opened you will need to restart the game.
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage