gamepads 0.1.1

Library to access information about connected gamepads.
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

[![CI](https://github.com/fornwall/gamepads/actions/workflows/ci.yml/badge.svg)](https://github.com/fornwall/gamepads/actions/workflows/ci.yml)
[![Docs](https://docs.rs/gamepads/badge.svg)](https://docs.rs/gamepads/)
[![Crates.io version](https://img.shields.io/crates/v/gamepads.svg)](https://crates.io/crates/gamepads)

# gamepads
Gamepad input library in Rust, optionally as a [macroquad](https://github.com/not-fl3/macroquad) plugin.

- On desktop this is an abstraction on top of [gilrs](https://crates.io/crates/gilrs).
- On web this is a direct (not using `wasm-bindgen`) implementation on top of the [Gamepad API](https://www.w3.org/TR/gamepad/) exposed by browsers.

Add the dependency as:

```toml
[dependencies]
gamepads = "0.1.1"
```

See the [crate documentation](https://docs.rs/gamepads/latest/gamepads/) and the [hello-gamepads example](https://github.com/fornwall/gamepads/tree/main/examples/hello-gamepads) for documentation and sample code.

## On web, as a macroquad plugin
For non-web targets, nothing special needs to be done to use this library with [macroquad](https://github.com/not-fl3/macroquad).

For a web build to work properly, a small javascript plug-in needs to be registered in the page embedding the built wasm file:

```html
<script src="https://not-fl3.github.io/miniquad-samples/mq_js_bundle.js"></script>
<script src="https://fornwall.github.io/gamepads/macroquad-gamepads-0.1.js"></script>
<script>
  load("your-wasm-file.wasm");
</script>
```

See the [hello-gamepads example](https://github.com/fornwall/gamepads/tree/main/examples/hello-gamepads).

# Feedback
Please [report any issues found](https://github.com/fornwall/gamepads/issues) or [discuss questions and ideas](https://github.com/fornwall/gamepads/discussions)!