Skip to content

Commit

Permalink
Update README documentation
Browse files Browse the repository at this point in the history
The README.md file has been updated for improved clarity and accuracy of information. It includes a more accurate description of button usage in the background and while entering text in-game. Additionally, guidance about vJoy version compatibility with joystick gremlin has been modified to ensure precision.
  • Loading branch information
bastianh committed Apr 2, 2024
1 parent 7008df8 commit 9ed9656
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@

### Why vJoy buttons instead of keyboard macros?

- the buttons can work when the game is the active application (alt-tabbed)
- it's not necessary to find unused modifier/keyboard combinations
- the buttons can work while the game is in the background (alt-tabbed)
- supports pressing multiple buttons at once
- you can use buttons while entering text in game (e.g. chat)
- you can use the buttons while entering text in game (e.g. open chat)
- supports feeding into tools like joystick gremlin to change modes or have duplicate bindings

### Features

- Supports up to 128 buttons
- Simple buttons that trigger a vJoy button when pressed, as long as it is pressed
- Toggle buttons that trigger a vJoy button until it is pressed again. It can show a different Title/Image while the button is active.
- Stream Deck + dial support to control vJoy axis
- Toggle buttons that trigger a vJoy button until it is pressed again. It can show a different Title/Image while the action is active.
- Stream Deck+ dial support to control vJoy axis

### Any Problems?

Expand All @@ -22,7 +21,7 @@ If you have any issues please create a issue here in github. Please check the lo
### Note

- This project uses the DLLs from vJoy v2.2.2.0 http://github.com/BrunnerInnovation/vJoy/releases/tag/v2.2.2.0.
It should also work with the installed vJoy version that is suggested by joystick gremlin.
It should also work with the vJoy version that is suggested by joystick gremlin. If you use joystick gremlin you should use their suggested vJoy version.

- This plugin uses the the [BarRaider's Stream Deck Tools](https://github.com/BarRaider/streamdeck-tools) as framework for the StreamDeck integration.

Expand Down

0 comments on commit 9ed9656

Please sign in to comment.