Skip to content

Commit

Permalink
Update readme with extra instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
DjCrqss authored Oct 24, 2022
1 parent 39bd3ac commit 4632586
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Woot-verlay
Pressure sensitive display for the analog values of your Wooting keyboard! Visit the page to mess around, or add it as a fully functional overlay to your streams.

## Running the site
## Running the app
### Website view
This application uses a localTCP server that must be kept running while using the website to display your values.
- Download/clone the repository locally.
Expand All @@ -16,15 +16,25 @@ This uses a browser source.
- Set the URL to the address of the PressureClient loaded in your webpage (it should look something like file:///C:/Users....../Woot-verlay/PressureClient.html)
- I recommend setting width to 800 and height to 200, and leave the next two options unticked
- In Custom CSS, add the line `.optionalInfo{ display: none;}` below the first pre-added line
- Once you have added all the keys, then add the line `#keyPool{display: none;}` which hides the sidebar
If it doesn't work after some time, open this menu back up and click 'Refresh cache of current page'

## Configuring your settings
Using the sidebar, you can add extra keys to the view.
Click and drag on the keys to shift them around, and hover then drag over the green or orange handles on the edges of a key to resize it.
Right click on any key to remove it.



---

## Planned features
- UI to allow showing/hiding any key.
- Theming with custom shapes and colours
- Preset configurations
- Showing actuation points
- Buttons to show/hide sidebar and log elements
- Support for non-wooting keyboards as a regular overlay
- Mouse support with keys and velocity



Expand Down

0 comments on commit 4632586

Please sign in to comment.