Semantic input library for games in Rust

Lucien Greathouse

Last update: Aug 27, 2022

Related tags

Miscellaneous keybee

Overview

Keybee

Keybee is a semantic input binding library. It's currently an early proof of concept that has been extracted from a larger game project, modified, and not well tested.

Keybee is built around straightforward core primitives:

Session holds all state for an application
Action defines anything a player can do, like jump or move
ActionSet groups together related actions
Bindings assigns inputs to actions

Features

winit: Enable support for winit events
gilrs: Enable support for gil-rs events

Getting Started

use keybee::{Session, EventAction, Clamped, Axis2dAction};

let session = keybee::Session::new();

let gameplay = session.create_action_set("gameplay");
let jump = gameplay.create_action("jump", EventAction);
let movement = gameplay.create_action("movement", Clamped(Axis2dAction));

// Keybee will have support for deserializing bindings from files, but for now,
// this isn't quite done.
session.use_bindings(todo!("load bindings from somewhere"));

loop {
    // Enable the `winit` or `gilrs` features to pass their events like this:
    session.handle_event(some_event);

    if jump.get() {
        println!("Player jumped!");
    }

    let translate = movement.get();
    if translate != [0.0, 0.0] {
        println!("Player movement vector: {:?}", translate);
    }

    // At the end of every game tick, run `end_update` to reset relative axis
    // movements and button presses.
    session.end_update();
}

Future Improvements

Support for multiple players
Other backends: SDL, others

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

An asynchronous Rust client library for the Hashicorp Vault API

vaultrs An asynchronous Rust client library for the Hashicorp Vault API The following features are currently supported: Auth AppRole JWT/OIDC Token Us

59 Dec 29, 2022

Culture ship names in a rust library.

General Systems Vehicles Culture Ships In case you ever needed Iain M. Banks's Culture ship names as a service. Names sourced from the pleasingly exte

1 Oct 18, 2021

Modrinth API is a simple library for using, you guessed it, the Modrinth API in Rust projects

Modrinth API is a simple library for using, you guessed it, the Modrinth API in Rust projects. It uses reqwest as its HTTP(S) client and deserialises responses to typed structs using serde.

21 Jan 1, 2023

Wrapper library for utilizing DigitalOcean API v2 in Rust

doapi-rs Wrapper library for utilizing DigitalOcean API v2 in Rust Disclaimer This library is in alpha - it may do anything up to, and including, eati

30 Nov 5, 2022

Rust LZ4 bindins library

lz4 This repository contains binding for lz4 compression library (https://github.com/Cyan4973/lz4). LZ4 is a very fast lossless compression algorithm,

155 Jan 3, 2023

Noto-sans-mono-bitmap (Rust library)

noto-sans-mono-bitmap (Rust library) Pre-rasterized bitmap font from "Noto Sans Mono", an open font from Google. Original font files taken from: https

21 Dec 7, 2022

Serenity is a Rust library for the Discord API

serenity Serenity is a Rust library for the Discord API. View the examples on how to make and structure a bot. Serenity supports bot login via the use

3.3k Jan 2, 2023

Deser: an experimental serialization and deserialization library for Rust

deser: an experimental serialization and deserialization library for Rust Deser is an experimental serialization system for Rust. It wants to explore

252 Dec 29, 2022

An (unofficial) Rust library for querying db-ip.com data

db_ip An (unofficial) library for querying db-ip.com CSV databases in safe Rust. This library is not affiliated with or endorsed by db-ip.com. Be advi

4 Dec 2, 2022

Comments

Support gamepad virtual cursor

Some games like Destiny 2 have a virtual cursor that can be moved with a gamepad. We should make changes to our state management to make this sorta thing possible.

opened by LPGhatguy 0
Multiple input keys

We should be able to bind keys like shift+P. If a binding like this is set, then anything bound to just P should not trigger if shift is held down. This is how WoW works. Maybe there are cases where it shouldn't work this way?

opened by LPGhatguy 1
Semantic action type names

Action type names should reflect the meaning of the action, not the mechanism used to trigger it (which may vary). For example, ButtonAction and ButtonHeldAction might be more descriptively named EventAction and BooleanAction to reflect their behavior rather than one possible input device. This should preempt confusion about e.g. why ButtonAction might yield false while a button is pressed.

opened by Ralith 0