Simple function for mouse
Get Started
$ dotnet add package MouseHookReadme
For 4.8 Use Release x64 /!\
GlobalMouseHook
Author: FauZaPespi
Date: 13.11.2024
Tired of having to rehook for each project? Use this already pre-made hook to call events at the right time, everything is perfect, use us
Description
A .NET library designed to globally hook mouse events, providing real-time monitoring and simulation of mouse actions. This library enables developers to intercept, track, and simulate mouse clicks programmatically.
Features
-
Global Mouse Hooking:
- Tracks mouse button events globally across the system.
- Monitors cursor position during mouse events.
-
Mouse Button State Tracking:
- Detects and stores the state of the left and right mouse buttons (
IsKeepingLeftDown,IsKeepingRightDown).
- Detects and stores the state of the left and right mouse buttons (
-
Mouse Click Simulation:
- Simulate left and right mouse button presses and releases (
SendLeftDown,SendLeftUp,SendRightDown,SendRightUp).
- Simulate left and right mouse button presses and releases (
-
Customizable Event Handling:
- Raises a
GlobalMouseClickevent when a mouse button is pressed or released, with details of the button and cursor position.
- Raises a
Getting Started
Prerequisites
- .NET Framework or .NET Core compatible runtime.
- Administrative privileges to hook global system events.
Installation
Clone or download the repository and include the GlobalMouseHook class in your project.
Usage
1. Set Up Global Mouse Hook
Instantiate the GlobalMouseHook class to start monitoring mouse events globally.
var mouseHook = new GlobalMouseHook();
mouseHook.GlobalMouseClick += (button, position) =>
{
Console.WriteLine($"Button: {button}, Position: {position}");
};
2. Check Mouse Button States
Use these methods to check the current state of the mouse buttons:
bool isLeftButtonPressed = mouseHook.IsLeftDown();
bool isRightButtonPressed = mouseHook.IsRightDown();
bool isLeftHeld = mouseHook.IsKeepingLeftDown();
bool isRightHeld = mouseHook.IsKeepingRightDown();
3. Simulate Mouse Actions
Simulate mouse clicks programmatically:
mouseHook.SendLeftDown();
mouseHook.SendLeftUp();
mouseHook.SendRightDown();
mouseHook.SendRightUp();
4. Clean Up Resources
Unhook the mouse hook when it is no longer needed:
mouseHook.Unhook();
Functionality
| Functionality | Description |
|---|---|
SetHook() | Sets up a global mouse hook using SetWindowsHookEx. |
Unhook() | Releases the global mouse hook using UnhookWindowsHookEx. |
HookCallback() | Processes mouse events and raises the GlobalMouseClick event. |
GlobalMouseClick (event) | Raised when a mouse button is pressed or released, providing button name and cursor position. |
IsLeftDown() | Checks if the left mouse button is currently pressed. |
IsRightDown() | Checks if the right mouse button is currently pressed. |
IsKeepingLeftDown() | Checks if the left mouse button is being held down. |
IsKeepingRightDown() | Checks if the right mouse button is being held down. |
SendLeftDown() | Simulates a left mouse button press. |
SendLeftUp() | Simulates a left mouse button release. |
SendRightDown() | Simulates a right mouse button press. |
SendRightUp() | Simulates a right mouse button release. |
License
This project is licensed under the MIT License. See the LICENSE file for details.