rig-ecs 0.43.0

rig inside a Bevy World: effects as entities, handlers as entities, the driver as a system.
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

//! Rig's effect bus and agent runtime as entities and systems in a Bevy world.
//!
//! [`RigPlugin`] installs request assembly, dispatch, streaming, tool execution,
//! memory, and retrieval. Hosts steer runs through components and save reflected
//! state with [`checkpoint`]. Concrete recording and replay adapters live in
//! `rig_cassette::ecs`; the optional `assets` feature loads prompts and tools.
//!
//! This crate is experimental: its API may change in minor releases. The
//! runtime behaviour its tests pin is stated in
//! [`CONTRACT.md`](https://github.com/0xPlaygrounds/rig/blob/main/crates/rig-ecs/CONTRACT.md).
//!
//! ```
//! let mut app = bevy_app::App::new();
//! app.add_plugins(rig_ecs::RigPlugin::default());
//! app.update();
//! ```

pub mod agent;
#[cfg(feature = "assets")]
pub mod assets;
pub mod bus;
pub mod checkpoint;
pub mod policy;
pub mod prelude;
pub mod reflect;
pub mod systems;

/// Installs bus and agent systems in [`bus::RigSchedule`] after `Update`, with
/// task-driven wakeups and checkpoint type registration. Adds time and
/// diagnostics plugins if absent.
#[derive(Debug, Clone, Default)]
pub struct RigPlugin {
    /// The bus's configuration: the serving policy, the ambiguity level.
    pub bus: bus::BusPlugin,
}

impl RigPlugin {
    /// The runtime under `policy`.
    pub fn with_policy(policy: rig_core::serve::ServingPolicy) -> Self {
        Self {
            bus: bus::BusPlugin::with_policy(policy),
        }
    }

    /// Build the schedule with ambiguity detection at `level`.
    #[must_use = "the setting applies to the returned value"]
    pub fn ambiguity_detection(mut self, level: bevy_ecs::schedule::LogLevel) -> Self {
        self.bus = self.bus.ambiguity_detection(level);
        self
    }
}

impl bevy_app::Plugin for RigPlugin {
    fn build(&self, app: &mut bevy_app::App) {
        if !app.is_plugin_added::<bevy_time::TimePlugin>() {
            app.add_plugins(bevy_time::TimePlugin);
        }
        if !app.is_plugin_added::<bevy_diagnostic::DiagnosticsPlugin>() {
            app.add_plugins(bevy_diagnostic::DiagnosticsPlugin);
        }
        app.add_plugins((self.bus.clone(), systems::AgentPlugin));
        checkpoint::register_types(app.world_mut());
    }
}