Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xwmtp authored Aug 7, 2019
1 parent a09525f commit bd61d53
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
# OoT input display skin
Ocarina of Time themed input display skin for NintendoSpy, based on the HUD you see in the game. Available both for Nintendo 64 and Gamecube controller.
Ocarina of Time themed input display skin for NintendoSpy, based on the HUD you see in the game. Available both for Nintendo 64 and Gamecube controller. There is also a Collector's Edition/MQ version available.

![input](https://github.com/xwmtp/oot-input-display/blob/master/docs/gc-input-2.gif)

The gif shows the Gamecube version of the input display, but they are identical apart from the L and Z buttons.
The gif shows the Gamecube OoT version of the input display, but it looks identical to N64 except for the L and Z buttons.

## Download
Please visit the [Releases](https://github.com/xwmtp/oot-input-display/releases) page to download the latest skins (the source code doesn't contain the images to make the skin work!).
Please visit the [Releases](https://github.com/xwmtp/oot-input-display/releases) page to download the latest skins. Pick the MQ version if you want grey start, red b and green a buttons like on the Collector's Edition.

Don't download the source code! It doesn't contain the images to make the skin work.

Unzip the downloaded folder containing the skin.xml and images and put it in the ```skins``` folder in the directory where ```NintendoSpy.exe``` is located.

## Color settings
Capture the window in OBS by adding a ```Window Capture``` source.

I recommend using the input display against a dark background in OBS, since I think it looks best that way. You can add a ```Color key``` filter to the source to get rid of the black background. Make sure to play a bit with the settings. In particular, I recommend a **smoothness** of 45 and keeping the **similarity** at 1.
I recommend using the input display against a dark background in OBS because I think it looks best, but anything works. You can add a ```Color key``` filter to the source to get rid of the black background. Make sure to play a bit with the settings. In particular, I recommend keeping the **similarity** at 1 and putting the **smoothness** to 45.

![settings](https://github.com/xwmtp/oot-input-display/blob/master/docs/obs-settings.png)

The skin shows button inputs by lighting the corresponding buttons up. If you would like the whole display to look a bit brighter/fainter, add a ```Color correction``` filter to the source to adjust the brightness or contrast, or see the next section.
The skin shows button inputs by lighting the corresponding buttons up. If you would like the whole display to look a bit brighter/dimmer, add a ```Color correction``` filter to the source to adjust the brightness or contrast, or see the next section.

## Brighter display
The downloaded skin will also have a brighter version of the background image. To use this one instead, open the ```skin.xml``` file in a text editor and put ```<background name="Basic" image="gc-skin-brighter.png"/>``` (GC skin example). This will make the contrast between buttons being pressed and unpressed smaller though.
The downloaded skin will also have a brighter version of the background image. To use this one instead, open the ```skin.xml``` file in a text editor and put ```<background name="Basic" image="gc-skin-brighter.png"/>``` (GC original skin example). This will make the contrast between buttons being pressed and unpressed smaller though.

## Requests
If people are interested in more skin variatons (red b button for the gamecube version of the game style or maybe items on the c-buttons), let me know by making an issue.
Expand Down

0 comments on commit bd61d53

Please sign in to comment.