🖱️ Bixat Key Mouse

Cross-platform (Linux, Windows, macOS & BSD) package to simulate keyboard and mouse events

Features

• 🖲️ Move mouse to absolute and relative positions
• 🖱️ Press and release mouse buttons
• 🖋️ Enter text programmatically
• ⌨️ Simulate key presses and releases
• 🗝️ Support for multiple key modifiers
• 🖥️ Desktop compatibility

Installation

To use Bixat Key Mouse in your Flutter project, add it to your pubspec.yaml file:

flutter pub add bixat_key_mouse

Then run flutter pub get to install the package.

Supported Platforms

Platform	Tested
Linux	No
Windows	No
macOS	Yes
BSD	No

Getting Started

To use Bixat Key Mouse in your Dart code, import the package:

import 'package:bixat_key_mouse/bixat_key_mouse.dart';

Basic Usage

Here's a simple example demonstrating various functionalities:

import 'package:bixat_key_mouse/bixat_key_mouse.dart';

void main() {
  // Move mouse to absolute position 🖱️
  BixatKeyMouse.moveMouse(x: x, y: y, coordinate: Coordinate.absolute);

  // Move mouse relative to current position ➡️
  BixatKeyMouse.moveMouse(x: x, y: y, coordinate: Coordinate.relative);

  // Click left mouse button 🖱️
  BixatKeyMouse.pressMouseButton(
    button: MouseButton.left,
    direction: Direction.click,
  );

  // Press left mouse button 🖱️
  BixatKeyMouse.pressMouseButton(
    button: MouseButton.left,
    direction: Direction.press,
  );

  // Release left mouse button 🖱️
  BixatKeyMouse.pressMouseButton(
    button: MouseButton.left,
    direction: Direction.release,
  );

  // Enter text 🖋️
  final text = 'Hello, world!';
  BixatKeyMouse.enterText(text);

  // Simulate key press ⌨️
  final key = UniversalKey.leftCommand;
  BixatKeyMouse.simulateKeyPress(key);

  // Release key ⌨️
  final keyRelease = UniversalKey.capsLock;
  BixatKeyMouse.simulateKeyPress(keyRelease, direction: Direction.release);
}

Available Functions

Mouse Control

moveMouseAbs(int x, int y)

Move the mouse cursor to an absolute position on the screen. 📍

BixatKeyMouse.moveMouse(x: x, y: y, coordinate: Coordinate.absolute);

moveMouseRel(int dx, int dy)

Move the mouse cursor relative to its current position. ➡️

BixatKeyMouse.moveMouse(x: x, y: y, coordinate: Coordinate.relative);

pressMouseButton(int button)

Press the specified mouse button. 🖱️

BixatKeyMouse.pressMouseButton(MouseButton.left); // Left mouse button
BixatKeyMouse.pressMouseButton(MouseButton.middle); // Middle mouse button
BixatKeyMouse.pressMouseButton(MouseButton.right); // Right mouse button

releaseMouseButton(int button)

Release the specified mouse button. 🖱️

BixatKeyMouse.pressMouseButton(
  button: MouseButton.left,
  direction: Direction.release,
);

Text Input

enterText(String text)

Enter text programmatically. 📜

final text = 'Hello, world!';
BixatKeyMouse.enterText(text);

Keyboard Simulation

simulateKeyPress(UniversalKey modifier, {Direction direction = Direction.press})

Simulate key press. ⌨️

final key = UniversalKey.leftCommand;
BixatKeyMouse.simulateKeyPress(key);

simulateKeyPress(UniversalKey modifier, {Direction direction = Direction.release})

Simulate key release. ⌨️

final keyRelease = UniversalKey.capsLock;
BixatKeyMouse.simulateKeyPress(keyRelease);

Advanced Usage

Combining Functions

You can combine mouse movements and key presses for complex interactions: 🔄

BixatKeyMouse.moveMouseAbs(100, 100);
BixatKeyMouse.pressMouseButton(1);
// Perform actions...
BixatKeyMouse.releaseMouseButton(1);

Handling Exceptions

The package throws exceptions when certain operations fail. It's recommended to handle these exceptions: ⚠️

try {
  BixatKeyMouse.moveMouseAbs(100, 100);
} catch (e) {
  print('Error moving mouse: $e');
}

Acknowledgements

The Bixat Key Mouse package utilizes the Enigo crate for simulating keyboard and mouse events across different platforms. Enigo is a Rust library that provides a cross-platform abstraction for controlling keyboards and mice, making it a valuable underlying tool for this package. 🎉

In addition, the Flutter Rust Bridge tool is used to facilitate seamless communication between Flutter and Rust, allowing efficient and safe function calls across language boundaries. This integration leverages Rust's performance and safety with Flutter's flexibility, further enhancing the package's capabilities. 🌉

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. 🤝

License

This project is licensed under the MIT License - see the LICENSE file for details. 📜