Skip to content

Commit

Permalink
Added a README
Browse files Browse the repository at this point in the history
  • Loading branch information
YellowAfterlife authored Oct 16, 2020
1 parent 1dfb0f4 commit cdb6a9d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# display_mouse_sim
Minimalistic mouse automation functions.

## Functions

- **display_mouse_button_press(button)**
Presses the given mouse button (analogous to `keyboard_key_press`)
- **display_mouse_button_release(button)**
Releases the given mouse button (analogous to `keyboard_key_release`)
- **display_mouse_button_check_direct(button)**
Checks if the given mouse button is currently held down (analogous to `keyboard_check_direct`)
- **display_mouse_wheel_scroll(amount)**
Sends a scroll wheel event.
Usually, amount of `120` is one scroll up and `-120` is one scroll down, but you may find that many applications don't actually care about amount at all, only the direction.

## Meta

**Author:** [YellowAfterlife](https://github.com/YellowAfterlife)
**License:** MIT

0 comments on commit cdb6a9d

Please sign in to comment.