Crate bevy_pkv

source ·
Expand description

§bevy_pkv

crates.io MIT/Apache 2.0 docs.rs ci

bevy_pkv is a cross-platform persistent key value store for rust apps.

Use it for storing things like settings, save games etc.

Currently, the Bevy dependency is optional, so it may be used in other games/apps as well.

§Usage with Bevy

Add a store resource to your app

use bevy::prelude::*;
use bevy_pkv::PkvStore;

fn main() {
App::new()
    .add_plugins(DefaultPlugins)
    .insert_resource(PkvStore::new("FooCompany", "BarGame"))
    // ...insert systems etc.
    .run();
}

This will create or load a store in the appropriate location for your system, and make it available to bevy systems:

fn setup(mut pkv: ResMut<PkvStore>) {
    if let Ok(username) = pkv.get::<String>("username") {
        info!("Welcome back {username}");
    } else {
        pkv.set_string("username", "alice")
            .expect("failed to store username");

        // alternatively, using the slightly less efficient generic api:
        pkv.set("username", &"alice".to_string())
            .expect("failed to store username");
    }
}

Using your own types implementing serde::Serialize and Deserialize:

#[derive(Serialize, Deserialize)]
struct User {
    name: String,
}

fn setup(mut pkv: ResMut<PkvStore>) {
    if let Ok(user) = pkv.get::<User>("user") {
        info!("Welcome back {}", user.name);
    } else {
        let user = User {
            name: "bob".to_string(),
        };
        pkv.set("user", &user).expect("failed to store user");
    }
}

See the examples for further usage

§Usage without Bevy

Disable the default features when adding the dependency:

bevy_pkv = {version = "0.9", default-features = false}

§Implementation details

§Native

redb and rmp_serde (MessagePack) is used for storage. It’s creating a bevy_pkv.redb db in the appropriate application data directory for your system.

Alternatively, disable default-features and enable the rocksdb feature to use a RocksDB-based implementation or sled feature to use sled db.

§Wasm

Window.localStorage and serde_json is used for storage. Perhaps IndexedDb and something else would have been a better choice, but its API is complicated, and I wanted a simple implementation and a simple synchronous API.

§Bevy version support

The main branch targets the latest bevy release.

bevybevy_pkv
0.140.11, main
0.130.10
0.120.9
0.110.8
0.100.7
0.90.6
0.80.5
0.70.2, 0.3, 0.4
0.60.1

§License

MIT or Apache-2.0

Structs§

  • Main resource for setting/getting values

Enums§

  • Errors that can occur during PkvStore::get
  • Errors that can occur during PkvStore::set