14 releases

0.6.1 Jul 18, 2018
0.6.0 Feb 11, 2018
0.5.2 Dec 30, 2017
0.5.1 Nov 12, 2017
0.3.1 Sep 23, 2016

#15 in Game engines

Download history 289/week @ 2018-05-27 406/week @ 2018-06-03 248/week @ 2018-06-10 323/week @ 2018-06-17 277/week @ 2018-06-24 404/week @ 2018-07-01 326/week @ 2018-07-08 581/week @ 2018-07-15 309/week @ 2018-07-22 241/week @ 2018-07-29 477/week @ 2018-08-05 287/week @ 2018-08-12 99/week @ 2018-08-19

1,336 downloads per month
Used in 2 crates

Apache-2.0/MIT

241KB
5.5K SLoC

GilRs - Game Input Library for Rust

pipeline status Crates.io Documentation

Documentation (master)

GilRs abstract platform specific APIs to provide unified interfaces for working with gamepads.

Main features:

  • Unified gamepad layout—buttons and axes are represented by familiar names
  • Support for SDL2 mappings including SDL_GAMECONTROLLERCONFIG environment variable which Steam uses
  • Hotplugging—GilRs will try to assign new ID for new gamepads and reuse same ID for gamepads which reconnected
  • Force feedback (rumble)
  • Power information (is gamepad wired, current battery status)

The project's main repository is on GitLab although there is also a GitHub mirror. Please use GitLab's issue tracker and merge requests.

This repository contains submodule; after you clone it, don't forget to run git submodule init; git submodule update (or clone with --recursive flag) or you will get compile errors.

Example

[dependencies]
gilrs = "0.6.1"
use gilrs::{Gilrs, Button, Event};

let mut gilrs = Gilrs::new();

// Iterate over all connected gamepads
for (_id, gamepad) in gilrs.gamepads() {
    println!("{} is {:?}", gamepad.name(), gamepad.power_info());
}

loop {
    // Examine new events
    while let Some(Event { id, event, time }) = gilrs.next_event() {
        println!("{:?} New event from {}: {:?}", time, id, event);
    }

    // You can also use cached gamepad state
    if gilrs[0].is_pressed(Button::South) {
        println!("Button South is pressed (XBox - A, PS - X)");
    }
}

Supported features

Input Hotplugging Force feedback
Linux
Windows (XInput)
OS X
Emscripten n/a
Android

Platform specific notes

Linux

On Linux, GilRs read (and write, in case of force feedback) directly from appropriate /dev/input/event* file. This mean that user have to have read and write access to this file. On most distros it shouldn't be a problem, but if it is, you will have to create udev rule.

To build GilRs, you will need pkg-config and libudev .pc file. On some distributions this file is packaged in separate archive (for example libudev-dev in Debian).

License

This project is licensed under the terms of both the Apache License (Version 2.0) and the MIT license. See LICENSE-APACHE and LICENSE-MIT for details.

Dependencies

~1MB
~13K SLoC