Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zenahr authored Jun 2, 2021
0 parents commit 26bc1e9
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# MouseVelViz - Mouse Velocity Visualizer

# Usage

1. Download the executable [here]().
2. start your game
3. start MouseVelViz
4. In OBS/StreamlabsOBS add a new `window capture source`
5. Add a `Chroma Key` filter with the following settings:

![]()

6. Add a `Color Correction` filter to change the line color. Here's an example configuration to make the lines appear white

![]()

# Pricing

Free of charge. MouseVelViz is a passion project of mine with no commercial intent whatsoever.

# Additional Notes

- MouseVelViz can only be run in `Administrator` mode. This is because of the API it's using under the hood (native Windows System API for `Raw Device Input`).
- Minimizing MouseVelViz will pause the mouse input processing. This means you won't see anything.
- MouseVelViz should work in fullscreened games as well as windowed ones.

0 comments on commit 26bc1e9

Please sign in to comment.