1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
//! 
//! # Mouse-rs
//!
//! Mouse-rs is a rust library for controlling your mouse from a rust program, without having to go into your kernel yourself.
//!
//! This project was loosely based on the python [mouse](https://github.com/boppreh/mouse/) library.
//! Currently it only supports windows based machines but I plan on adding unix later.
//!
//! ## Installation
//! Add mouse-rs to your cargo.toml
//!
//! ```toml
//! [dependencies]
//! mouse-rs = "0.4"
//! ```
//!
//! ## Example
//! This is a simple example that moves your mouse to a position on screen and presses the left button.
//!
//! ```no_run
//! use mouse_rs::{types::keys::Keys, Mouse};
//!
//! fn move_and_press() {
//! let mouse = Mouse::new();
//! mouse.move_to(500, 500).expect("Unable to move mouse");
//! mouse.press(&Keys::RIGHT).expect("Unable to press button");
//! mouse.release(&Keys::RIGHT).expect("Unable to release button");
//! }
//! ```
//!
//! ## Linux disclaimer
//! If you're running into problems building on linux you need to install libxdo-dev.
//!
//! #### Ubuntu
//! ```bash
//! sudo apt-get install libxdo-dev
//! ```
mod mouse;
mod sys;
pub mod types;
pub use mouse::Mouse;