sparsey 0.9.0

Sparse set-based entity component system
Documentation

Sparsey

Crates.io Documentation

Sparsey is a sparse set-based Entity Component System with lots of features and beautiful syntax ~( ˘▾˘~)

Example

use sparsey::prelude::*;

struct Position(f32);
struct Velocity(f32);
struct Frozen;

fn update_velocities(mut velocities: CompMut<Velocity>, frozen: Comp<Frozen>) {
    (&mut velocities).include(&frozen).for_each(|velocity| {
        velocity.0 = 0.0;
    });
}

fn update_positions(mut positions: CompMut<Position>, velocities: Comp<Velocity>) {
    (&mut positions, &velocities).for_each(|(position, velocity)| {
        position.0 += velocity.0;
    });
} 

fn main() {
    let mut schedule = Schedule::builder()
        .add_system(update_velocities)
        .add_system(update_positions)
        .build();

    let mut world = World::default();
    schedule.set_up(&mut world);

    world.create((Position(0.0), Velocity(1.0)));
    world.create((Position(0.0), Velocity(2.0)));
    world.create((Position(0.0), Velocity(3.0), Frozen));

    let mut resources = Resources::default();

    for _ in 0..5 {
        schedule.run(&mut world, &mut resources);
    }
}

Features

Easy to Use Systems

Systems are plain functions that borrow data from World and Resources.

fn update_positions(mut positions: CompMut<Position>, velocities: Comp<Velocity>) {
    (&mut positions, &velocities).for_each(|(position, velocity)| {
        position.0 += velocity.0;
    });
}

fn update_hps(mut hps: CompMut<Hp>, heals: Comp<Heal>, heal_multipler: Res<HealMultiplier>) {
    (&mut hps, &heals).for_each(|(hp, heal)| {
        hp.0 += heal.0 * heal_multiplier.0;
    });
}

Systems will be scheduled to run in parallel if their paramters don't conflict.

let schedule = Schedule::builder()
    .add_system(update_positions)
    .add_system(update_hps)
    .build();

Expressive Queries

Get, include and exclude components using Sparsey's query API.

fn queries(a: Comp<A>, b: Comp<B>, c: Comp<C>, d: Comp<D>, e: Comp<E>) {
    // Iter components A and B from entities with A and B.
    for (a, b) in (&a, &b).iter() {}

    // Iter components A from entities with A and B.
    for a in (&a).include(&b).iter() {}

    // Iter components A from entities with A and without B.
    for a in (&a).exclude(&b).iter() {}

    // Iter components A from entities with A and B, without C.
    for a in (&a).include(&b).exclude(&c).iter() {}
}

Great Performance with Grouped Storages

Sparsey allows the user to "group" component storages to greatly optimize iteration performance.

Groups are created by setting a Layout on the World.

let layout = Layout::builder()
    .add_group(<(A, B)>::group())
    .add_group(<(A, B, C, D>)>::group())
    .build();

let world = World::with_layout(&layout);

After the layout is set, iterators over the grouped storages become "dense", greatly improving their performance. Additionally, grouped storages allow access to their components and entities as slices.

fn dense_iterators(a: Comp<A>, b: Comp<B>, c: Comp<C>, d: Comp<D>) {
    assert!((&a, &b).iter().is_dense());
    assert!((&a, &b, &c, &d).iter().is_dense());
    assert!((&a, &b).exclude((&c, &d)).iter().is_dense());

    // These return Some(_) if the storages are grouped and None otherwise.
    let _: Option<&[Entity]> = (&a, &b).as_entity_slice();
    let _: Option<(&[A], &[B])> = (&a, &b).as_component_slices();
    let _: Option<(&[Entity], (&[A], &[B]))> = (&a, &b).as_entity_and_component_slices();
}

Thanks

Sparsey takes inspiration and borrows features from other free and open source ECS projects, namely Bevy, EnTT, Legion, Shipyard and Specs. Make sure you check them out!

License

Sparsey is dual-licensed under either

at your option. 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.