Skip to content

Commit

Permalink
edit readme to reflect changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dinir committed Jan 31, 2017
1 parent af6c13e commit e7cc6c7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions options.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
};

0 comments on commit e7cc6c7

Please sign in to comment.