diff --git a/README.md b/README.md index 263cacb..85386c4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > Because $300 plus shipping and a two month wait is too painful for a tasoller -Run this together alongside SUSPlayer or your other favourite sliding universal score simulator. +Run this together alongside SUSPlayer or your other favourite sliding universal score simulator to play with a tablet device. [Demo play](https://www.youtube.com/watch?v=xhxCB26Jqf4) @@ -22,7 +22,7 @@ Run this together alongside SUSPlayer or your other favourite sliding universal ![firewall](images/firewall.png) - > When using windows hotspot, ensure 'public' is enabled. If there are any other issues, try checking the "incoming rules" menu of windows firewall from the control panel. + > When using windows hotspot, ensure "public" is enabled. If there are any other issues, try checking the "incoming rules" menu of windows firewall from the control panel. > You may need to grant firewall permissions the first time and then restart the program. @@ -30,12 +30,16 @@ Run this together alongside SUSPlayer or your other favourite sliding universal ![running window](images/link.png) -6. If you see 'Controller ID ? Connected', the controller is working! +6. If you see "Controller ID ? Connected" on the console, the controller is working! ![connected](images/connected.png) 7. Open up SUSplayer or some other simulator and have fun! + > Make sure to set `InputType=1` in SUSPlayer's `Config.ini`; this program simulates the Yuancon keyboard layout + +### Further Setup + I also recommend using the "Add to home" feature for Safari / Chrome, it makes the controller fullscreen. After that you can also use "guided access" mode to disable the iOS app switcher gestures. ![add to home](images/homescreen.png) @@ -48,20 +52,50 @@ The difference between Safari and "Add to home" looks like this: Options for the server can be changed with command line arguments, check `.\brokenithm-kb.exe -h` or edit `run.bat`. +Example usage: + +```bat +REM Just run brokenithm-kb +.\brokenithm-kb.exe + +REM View help +.\brokenithm-kb.exe -h + +REM Run on a different port +.\brokenithm-kb.exe -p 1117 + +REM Run polling rate of 1000 times a second (default is 100) +.\brokenithm-kb.exe -f 1000 + +REM Run in verbose mode to check if button presses are detected +.\brokenithm-kb.exe -v + +REM Run in verbose + dry run mode which doesn't send any keypreses +.\brokenithm-kb.exe -v -d +``` + Appearance of the touchscreen controller can be changed by editing `./res/www/config.js`. You can change the displayed colors and also add a background image URL to the controller. Just upload an image to imgur or somewhere else and place the link there. +## Troubleshooting + +> I can open the webpage controller in chrome on the windows computer itself but clicking does not do anything + +The webpage controller only detects touch input; try use your web browser's devtools and enable ["Touch Device" mode](https://developer.chrome.com/docs/devtools/device-mode/#viewport), then try again. + +> I can access the webpage controller on my windows machine but not on my device + +- Make sure your devices are connected to the same wifi / ethernet hospot. +- Try using windows hotspot. +- Try running as administrator. +- Try changing the port used for the server (see [Options](#Options)) +- Double check that your firewall is set up correctly. + +![firewall debug](images/firewall-debug.png) + ## Building from source -Needs cmake and some vcpkg packages: - -``` -libuv:x64-windows -openssl-windows:x64-windows -openssl:x64-windows -usockets:x64-windows -zlib:x64-windows -``` +Needs cmake and the `libuv:x64-windows` vcpkg package. Built on windows `cl.exe 19.28.29337`. diff --git a/images/firewall-debug.png b/images/firewall-debug.png new file mode 100644 index 0000000..b3ab396 Binary files /dev/null and b/images/firewall-debug.png differ diff --git a/scripts/run.bat b/scripts/run.bat index a56c637..c48c972 100644 --- a/scripts/run.bat +++ b/scripts/run.bat @@ -3,8 +3,17 @@ ECHO OFF REM Just run brokenithm-kb .\brokenithm-kb.exe +REM View help +REM .\brokenithm-kb.exe -h + REM Run on a different port REM .\brokenithm-kb.exe -p 1117 -REM Run in debug mode +REM Run polling rate of 1000 times a second +REM .\brokenithm-kb.exe -f 1000 + +REM Run in verbose mode to check if button presses are detected REM .\brokenithm-kb.exe -v + +REM Run in verbose + dry run mode which doesn't send any keypreses +REM .\brokenithm-kb.exe -v -d