input_query 0.2.0

A library for querying key states without a window.
Documentation 
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

# input_query

A cross-platform Rust library for querying keyboard key states without requiring a window context.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Features

- 🖥️ **Cross-platform**: Supports Linux, Windows, and macOS
- 🚀 **No window required**: Query keyboard state directly from the OS
- 🎯 **Simple API**: Easy-to-use interface with minimal boilerplate
- 🔧 **Platform-optimized**: Uses native APIs for best performance on each platform

## Platform Support

| Platform | API Used | Notes |
|----------|----------|-------|
| **Linux** | `evdev` | Requires read access to `/dev/input/event*` devices |
| **Windows** | `GetAsyncKeyState` (Win32) | No special permissions required |
| **macOS** | `CGEventSourceKeyState` (Core Graphics) | Requires "Input Monitoring" permission |

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
input_query = "0.1.0"
```

## Usage

```rust
use input_query::{InputHandler, KeyCode};

fn main() {
    let mut handler = InputHandler::new();

    loop {
        handler.update_inputs();
        
        if handler.is_pressed(KeyCode::KeyEsc) {
            println!("Escape key is pressed!");
            break;
        }
        
        if handler.is_pressed(KeyCode::KeySpace) {
            println!("Space bar is pressed!");
        }
        
        // Your application logic here
        std::thread::sleep(std::time::Duration::from_millis(10));
    }
}
```

## Platform-Specific Setup

### Linux

On Linux, you need read access to input devices. You can either:

1. Add your user to the `input` group:
   ```bash
   sudo usermod -a -G input $USER
   ```
   Then log out and log back in.

2. Or run your application with appropriate permissions (not recommended for production).

### macOS

On macOS, the application needs "Input Monitoring" permission:

1. Run your application
2. When prompted, or manually go to: **System Preferences → Security & Privacy → Privacy → Input Monitoring**
3. Add and enable your application

### Windows

No special setup required on Windows.

## Supported Keys

The library currently supports:
- All letter keys (A-Z)
- Number keys (0-9)
- Function keys (F1-F12)
- Modifier keys (Shift, Ctrl, Alt, Caps Lock)
- Arrow keys
- Common symbol keys (brackets, punctuation, etc.)
- Space, Enter, Backspace, Tab, Escape

See the [`KeyCode`](https://docs.rs/input_query/latest/input_query/input_handler/enum.KeyCode.html) enum for the complete list.

## API Documentation

For detailed API documentation, run:

```bash
cargo doc --open
```

Or visit [docs.rs](https://docs.rs/input_query) (once published).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributing

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

## Acknowledgments

- Linux implementation uses the excellent [evdev](https://crates.io/crates/evdev) crate
- Windows implementation uses the [windows](https://crates.io/crates/windows) crate
- macOS implementation uses the [core-graphics](https://crates.io/crates/core-graphics) crate