Skip to content

Commit a653830

Browse files
committed
Document systems aggregator
1 parent 1af0428 commit a653830

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

crates/systems/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# Systems
22

3-
High-level systems including AI, physics solvers, acoustics, and save systems.
3+
The `systems` workspace crate bundles LP's high-level simulation layers
4+
(decision-making, acoustics, future MPM integration, and persistence) so they
5+
can be added to a Bevy app with a single plugin. It sits on top of the domain
6+
crates (`energy`, `forces`, `information`, `matter`) and takes care of wiring and
7+
scheduling.
8+
9+
## Modules
10+
11+
- `ai` - utility-driven agency used by LP's creatures and actors.
12+
- `acoustics` - scaffold for physics-based sound that will hook into matter and
13+
wave simulation.
14+
- `mpm` - placeholder for the upcoming Material Point Method solver.
15+
- `save_system` - shared save / load infrastructure.
16+
17+
Each module exposes a `prelude` for selective use, while
18+
`systems::SystemsPlugin` pulls everything together.
19+
20+
## Quick start
21+
22+
```rust
23+
use bevy::prelude::*;
24+
use systems::prelude::*;
25+
26+
fn main() {
27+
App::new()
28+
.add_plugins(DefaultPlugins)
29+
.add_plugins(SystemsPlugin::default())
30+
.run();
31+
}
32+
```

0 commit comments

Comments
 (0)