typed_ecs 0.0.1

A no_std, no_alloc Entity Component System with compile-time guarantees
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

# typed_ecs

[![no_std](https://img.shields.io/badge/no__std-supported-brightgreen)](https://docs.rust-embedded.org/book/intro/no-std.html)
[![Alloc-free](https://img.shields.io/badge/no__alloc-supported-brightgreen)](https://doc.rust-lang.org/alloc/)
[![License](https://img.shields.io/badge/license-MIT-orange)](https://github.com/heydocode/typed_ecs)

A `no_std` and `no-alloc` tiny ECS written in Rust, which provides strong compile-time guarantees.

This project is in active development but is ready to be used, just note that its API will break often until v0.1.x releases.

## About

`typed_ecs` is a tiny, zero-cost framework that:

- lets you wire plugins together at **compile time** using tuple-based plugin lists
- enforces plugin / shared-data compatibility via Rust trait bounds (no runtime checking)
- is written for `no_std` and `no_alloc` environments (small, deterministic runtime)

## Key features

- `no_std` compatible, and `no-alloc`: all kinds of platforms supported
- Compile-time plugin composition
- Strong compile-time guarantees for plugin/SharedData compatibility
- Zero runtime-registration or reflection — everything resolved at compile time
- Light, optimized runtime loop, with direct plugin calls
- Ergonomic design: no tricky or cryptic code needed to use `typed_ecs`

## Examples

Explore the examples to see `typed_ecs` in action:

```shell
git clone https://github.com/heydocode/typed_ecs.git
cd typed_ecs
cargo run --example hello_world
```

Check the `examples/` directory for more comprehensive examples, including:

- `hello_world.rs`: Plugin definition and message on startup

## Contributing

We welcome contributions! Whether you're interested in:

- Reporting bugs
- Writing code
- Improving documentation
- Enhancing CI/CD pipelines
- Adding tests
- Creating a dedicated website

Please check our [Contribution Guidelines](CONTRIBUTING.md) first.

For larger contributions or significant changes (like creating a website), we recommend:

1. Opening an issue using the [Question template](.github/ISSUE_TEMPLATE/question.md)
2. Discussing your approach with maintainers
3. Getting alignment on design and implementation details

This ensures your efforts align with project goals and standards. For smaller fixes like documentation tweaks or test additions, feel free to submit a PR directly.