From e7cc6c7285d842104891d07fd3a639e1f3cdc0dc Mon Sep 17 00:00:00 2001 From: Dinir Nertan Date: Tue, 31 Jan 2017 21:02:48 +0900 Subject: [PATCH] edit readme to reflect changes --- README.md | 12 +++++++++--- options.js | 6 +++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3043d29..aec671f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,12 @@ Simple Xbox gamepad tracker for use with [OBS](https://obsproject.com) streaming. ## Setup -Keep these files in the same place: `xboxpadviewer.html`, `mapping.css`, `options.js`, `dot.png`. +Download the files as ZIP and extract it. +These files are essential, keep them in the same place: `xboxpadviewer.html`, `mapping.css`, `options.js`, `dot.png`. +You can make changes on colors, fade-out times, etc. in `options.js`. + +Or, without downloading any files you can just load [the hosted html page](https://dinir.github.io/xbox-pad-viewer/xboxpadviewer.html) directly from OBS. + Width and height for one gamepad to display is 220x156. Press any key on the gamepad and the viewer will show the buttons. @@ -13,10 +18,11 @@ Add a browser source and set it to load the html file. ### Linux Open the html file and click 'Open in new window' button to open the same page in a small window. -Add a window capture and set it to show the small window. +Add a window capture and set it to capture the small window. +Crop the edges properly. ## Tested with -Xbox Controller (360, One) +Xbox Controller (360, One), DualShock4 Windows 8.1, Windows 10, ArchLinux Chrome diff --git a/options.js b/options.js index a0b58c4..a3b9691 100644 --- a/options.js +++ b/options.js @@ -5,9 +5,9 @@ var gpConstants = { ,defaultColor: "white" // what color the text of the pressed button should turn to? ,pressedButtonColor: "orange" - // change the hue of colors of the buttons. + // change the hue of buttons. // this affects background color of pressed buttons as well as - // the text color of buttons. + // the default color of buttons. // if you want to separately change the background color, // modify the single pixel image file `dot.png`. ,pressedButtonBackgroundColorHue: "0" @@ -22,6 +22,6 @@ var gpConstants = { ,fadeOutTime: [8, 16, 32] // set the strength of the fade-out for each timing above. (0~1) ,fadeOutStrength: [.5, .9, 1] - // set the seconds the fade-out applies through. + // set the seconds each fade-out applies through. ,fadeOutDuration: 4 };