planck_ecs 1.1.0

A tiny but very powerful ECS framework.
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

Support an Open Source Developer! :hearts:  

[![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/jojolepro)

# Planck ECS
The full ECS (Entity-Component-System) library.

Composed of two smaller libraries:
* [world_dispatcher](https://github.com/jojolepro/world_dispatcher): the `System` part of the ECS.
* [entity_component](https://github.com/jojolepro/entity_component): the `Entity-Component` part of the ECS.

Read the [documentation](https://docs.rs/planck_ecs).

# Why would you use this ECS library?

* Compatible with all platforms, including WASM!
* Fast enough on *every* operation, not just iteration.
* Public domain licensing: CC0
* Minimal amount of dependencies.
* Small code size.
* Stable, tested, benchmarked, 100% completed.
* Ability to handle system errors instead of crashing.
* Convert both functions and closures into systems!
* Safe: only 3 `unsafe` in total. (compared to hundreds in mainstream ECS libraries!)

# Usage
Add the following to you Cargo.toml file:
```
planck_ecs = "1.0.0"
```

Use it like so:
```rust
use planck_ecs::*;
fn main() {
    #[derive(Default)]
    pub struct A;

    let mut world = World::default();

    let sys = (|comps: &mut Components<A>, entities: &mut Entities| {
        let entity = entities.create();
        comps.insert(entity, A);
        Ok(())
    }).system();

    let mut dispatch = DispatcherBuilder::new().add_system(sys).build(&mut world);
    dispatch.run_seq(&world).unwrap();
    dispatch.run_seq(&world).unwrap();
    dispatch.run_seq(&world).unwrap();

    assert!(world.get::<Components<A>>().is_ok());
}
```

For more examples, see the two following repositories' example folders and documentation:
* [world_dispatcher](https://github.com/jojolepro/world_dispatcher): information on systems, world and dispatchers.
* [entity_component](https://github.com/jojolepro/entity_component): information on entities, components and joins.

### Maintainer Information

* Maintainer: Jojolepro
* Contact: jojolepro [at] jojolepro [dot] com
* Website: [jojolepro.com](https://jojolepro.com)
* Patreon: [patreon](https://patreon.com/jojolepro)

### Licence

CC0, public domain.

TLDR: You can do whatever you want with it. Have fun!