stickup 0.2.0

A modular input device abstraction layer with HID and virtual device support.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

# StickUp

> 🚀 **Update: v0.2.0 is here!**  
> StickUp now supports full per-frame state snapshots, binding resolution (`"joy0.axis1"`), and cleaner device management via the new `DeviceManager`.  
> Built to scale with sim rigs, overlays, game engines, and beyond.  

## Already passed 500 downloads in 24 hours — thank you to everyone testing and sharing it

[![Crates.io](https://img.shields.io/crates/v/stickup)](https://crates.io/crates/stickup)
[![Downloads](https://img.shields.io/crates/d/stickup)](https://crates.io/crates/stickup)
[![Join the Discord](https://img.shields.io/discord/1068768849186840738?label=chat&logo=discord)](https://discord.gg/EKeBNYnaSh)
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-Ko--fi-FF5E5B?logo=kofi&logoColor=white)](https://ko-fi.com/belegrades)
[![Follow on X](https://img.shields.io/badge/follow-%40BelegradeGG-1DA1F2?style=flat&logo=x)](https://x.com/BelegradeOfRuin)

---

## 🔐 Security Note

The name stickup was previously used in 2023 for a malicious crate which has since been removed from crates.io. (I wasn't aware of this at the time of publishing.)

This version — authored by Belegrade Studio — is a clean and fully rewritten project, unrelated to the original.

    ✅ No build.rs
    ✅ No network activity
    ✅ 100% open and auditable

Transparency and trust matter. You're welcome to inspect the source or reach out directly

---

**StickUp** is a modular, high-performance input framework for Rust.  
It supports both HID and virtual devices with precision, persistence, and clarity.

> Created by **Belegrade Studio** as part of the **CelerisTech** stack.

---

## ✨ Features

- 🔌 Plug-and-play device management via `DeviceManager`
- 🎮 Unified `Device` trait for axis + button input
- 🧠 Persistent device identity (hardware fingerprint)
- 🧰 Binding resolution like `"joy0.axis1"` → `Option<f32>`
- 🔁 Per-frame polling and snapshot state tracking
- 🔧 Hotplug-friendly and fully extendable
- 🛠 Supports `hid` and `virtual` backends via features
- 💡 Zero magic — minimal, intentional design

---

## 📦 Installation

```toml
stickup = { version = "0.2.0", features = ["hid", "virtual"] }
```

---

## 🚀 Quick Start

```rust
use stickup::DeviceManager;

fn main() {
    let mut input = DeviceManager::new();
    input.snapshot(); // poll + build snapshot

    if let Some(throttle) = input.get_axis("joy0.throttle") {
        println!("Throttle: {:.2}", throttle);
    }

    if input.is_pressed("joy1.trigger") {
        println!("Trigger is pressed!");
    }
}
```

---

## 📋 Full Snapshot Example

```rust
let mut input = DeviceManager::new();
let state = input.snapshot();

for (id, device_state) in state.iter() {
    println!("Device: {id}");

    for (axis, value) in &device_state.axes {
        println!("  Axis {axis}: {value:.2}");
    }

    for (button, pressed) in &device_state.buttons {
        println!("  Button {button}: {}", if *pressed { "Pressed" } else { "Released" });
    }
}
```

---

## 🧬 Device Identity

StickUp assigns a stable, persistent ID to each device:

```
vendor_id:product_id:serial_number
# Example: 044f:0402:ABCD1234
```

---

## 🔍 Examples

Run any with:

```sh
cargo run --example <name>
```

- `poll` – Print a full snapshot of all input state
- `virtual_demo` – Feed input into a simulated virtual device

---

## 🛠️ Optional Features

| Feature | Description |
|--------|-------------|
| `hid` (default) | Enables HID device support via `hidapi` |
| `virtual` | Enables manually fed virtual devices |

---

## 🧭 Philosophy

StickUp is about **presence, clarity, and persistence**.  
It doesn't guess. It doesn't simulate. It reflects exactly what your device is doing — no more, no less.

---

## 📜 License

This project is licensed under the **Pact of the Amaranth Rite**.  
See [`LICENSE`](./LICENSE) for details.

### Third-Party Dependencies

StickUp uses the following libraries, each under permissive open source licenses:

- [`hidapi`](https://github.com/libusb/hidapi) — MIT/Apache-2.0 (HID support)
- [`serde`](https://github.com/serde-rs/serde) — MIT/Apache-2.0 (serialization)
- [`serde_json`](https://github.com/serde-rs/json) — MIT/Apache-2.0 (layout/config IO)
- [`toml`](https://github.com/alexcrichton/toml-rs) — MIT/Apache-2.0 (if config parsing used)

---

## 💬 Connect

- ✉️ Email: [belegrade@belegrades.gg](mailto:belegrade@belegrades.gg)
- 💬 Discord: [Join the Chat](https://discord.gg/EKeBNYnaSh)
- 🎮 Sim pilots & devs: I’d love to hear how you’re using StickUp.