diff --git a/.config/mise.toml b/.config/mise.toml
index e52f235..10e5b52 100644
--- a/.config/mise.toml
+++ b/.config/mise.toml
@@ -1,5 +1,10 @@
experimental_monorepo_root = true
+[monorepo]
+config_roots = [
+ "crates/template/.config"
+]
+
[env]
_.source = ".config/env.sh"
diff --git a/crates/template/CHANGELOG.md b/crates/app/CHANGELOG.md
similarity index 100%
rename from crates/template/CHANGELOG.md
rename to crates/app/CHANGELOG.md
diff --git a/crates/template/Cargo.toml b/crates/app/Cargo.toml
similarity index 100%
rename from crates/template/Cargo.toml
rename to crates/app/Cargo.toml
diff --git a/crates/template/README.md b/crates/app/README.md
similarity index 70%
rename from crates/template/README.md
rename to crates/app/README.md
index 74714fd..d55f5d0 100644
--- a/crates/template/README.md
+++ b/crates/app/README.md
@@ -1,10 +1,4 @@
-
-
-
())
}
+ /// Label of a schedule which fires when the screen has begun its cleanup schedule.
+ /// Try to avoid spawning anything during this schedule.
+ #[derive(ScheduleLabel, Debug, PartialEq, Eq, Hash, Clone, Copy)]
+ pub struct OnScreenCleanup(pub TypeId);
+ /// See [OnScreenCleanup]
+ pub fn on_screen_cleanup() -> impl ScheduleLabel {
+ OnScreenCleanup(TypeId::of::())
+ }
+ /// Label of a schedule which fires when the screen is waiting to load.
+ #[derive(ScheduleLabel, Debug, PartialEq, Eq, Hash, Clone, Copy)]
+ pub struct OnScreenLoadQueued(pub TypeId);
+ /// See [OnScreenLoadQueued]
+ pub fn on_screen_load_queued() -> impl ScheduleLabel {
+ OnScreenLoadQueued(TypeId::of::())
+ }
+
/// Label of a schedule which fires when the screen has finished loading.
#[derive(ScheduleLabel, Debug, PartialEq, Eq, Hash, Clone, Copy)]
pub struct OnScreenReady(pub TypeId);
diff --git a/crates/screens/src/scope.rs b/crates/screens/src/scope.rs
index 03c230e..7709bf3 100644
--- a/crates/screens/src/scope.rs
+++ b/crates/screens/src/scope.rs
@@ -1,7 +1,10 @@
use std::any::TypeId;
pub use crate::prelude::*;
-use bevy::{ecs::system::ScheduleSystem, platform::collections::HashMap};
+use bevy::{
+ ecs::system::{ScheduleSystem, SystemIdMarker},
+ platform::collections::HashMap,
+};
use strum::IntoEnumIterator;
#[allow(missing_docs)]
@@ -140,6 +143,7 @@ where
app.add_observer(on_switch_screen::);
app.add_observer(on_finish_loading::);
app.add_observer(on_finish_unloading::);
+ app.add_systems(on_screen_cleanup::(), clean_up_scoped_entities::);
// scope systems
for (kind, schedule) in self.schedules.into_iter() {
@@ -159,7 +163,7 @@ where
ScreenSchedule::OnUnload => {
let label = schedule.label();
app.add_systems(on_screen_unload::(), move |mut commands: Commands| {
- commands.run_schedule(label)
+ commands.run_schedule(label);
});
}
ScreenSchedule::OnUnloaded => {
@@ -178,16 +182,25 @@ where
// Lifecycle
#[cfg(debug_assertions)]
{
- app.add_systems(on_screen_load::(), || debug!("Loading {:?}", S::name()));
- app.add_systems(on_screen_ready::(), || debug!("Ready {:?}", S::name()));
+ app.add_systems(on_screen_load_queued::(), || {
+ debug!("LoadQueued {:?}", S::name())
+ });
+ app.add_systems(on_screen_load::(), || {
+ debug!(" Loading {:?}", S::name())
+ });
+ app.add_systems(on_screen_ready::(), || {
+ debug!(" Ready {:?}", S::name())
+ });
app.add_systems(on_screen_unload::(), || {
- debug!("Unloading {:?}", S::name())
+ debug!(" Unloading {:?}", S::name())
+ });
+ app.add_systems(on_screen_cleanup::(), || {
+ debug!(" Cleanup {:?}", S::name())
});
app.add_systems(on_screen_unloaded::(), || {
- debug!("Unloaded {:?}", S::name())
+ debug!(" Unloaded {:?}", S::name())
});
}
- app.add_systems(on_screen_unloaded::(), clean_up_scoped_entities::);
debug!("Built {} (id={:?})", S::name(), id);
}
}
@@ -224,13 +237,22 @@ fn clean_up_scoped_entities(
)>,
),
>,
- top_levels: Query, With)>, Without)>,
+ top_levels: Query<
+ Entity,
+ (
+ Or<(With, With, With)>, // there are probably others i'm missing
+ Without,
+ ),
+ >,
) {
screen_scoped
.iter()
.filter(|c| !top_levels.iter().contains(c))
.for_each(|e| {
- commands.entity(e).detach_all_children().despawn();
+ if let Ok(mut cmds) = commands.get_entity(e) {
+ cmds.clear(); // removes all relationship components
+ cmds.despawn();
+ }
});
- screen_data.unload();
+ screen_data.finish_cleanup();
}
diff --git a/crates/screens/src/systems.rs b/crates/screens/src/systems.rs
index acd57f2..9cde586 100644
--- a/crates/screens/src/systems.rs
+++ b/crates/screens/src/systems.rs
@@ -22,7 +22,7 @@ fn handle_switch_msg(
for (key, value) in registry.iter_mut().enumerate() {
if let Some(data) = value {
if key == *msg_key.0 {
- data.load(tick.this_run());
+ data.queue_load(tick.this_run());
} else {
data.unload(tick.this_run());
}
@@ -60,6 +60,13 @@ pub(crate) fn on_finish_unloading(
}
fn run_schedules(mut data: ResMut, mut commands: Commands, tick: SystemChangeTick) {
+ let all_clear = data.iter().filter_map(|info| info.as_ref()).all(|info| {
+ matches!(
+ info.state(),
+ ScreenState::Unloaded | ScreenState::LoadQueued
+ )
+ });
+
for info in data.iter_mut().filter_map(|info| info.as_mut()) {
match info.state() {
ScreenState::Unloaded => {
@@ -74,6 +81,16 @@ fn run_schedules(mut data: ResMut, mut commands: Commands, tick: Sys
info.changed_at = tick.this_run();
}
}
+ ScreenState::LoadQueued => {
+ if info.needs_update {
+ commands.run_schedule(OnScreenLoadQueued(info.type_id()));
+ info.needs_update = false;
+ info.changed_at = tick.this_run();
+ }
+ if all_clear {
+ info.load(tick.this_run());
+ }
+ }
ScreenState::Loading => {
commands.run_schedule(ScreenScheduleLabel::from_id(
ScreenSchedule::Loading,
@@ -113,6 +130,13 @@ fn run_schedules(mut data: ResMut, mut commands: Commands, tick: Sys
info.changed_at = tick.this_run();
}
}
+ ScreenState::Cleanup => {
+ if info.needs_update {
+ commands.run_schedule(OnScreenCleanup(info.type_id()));
+ info.needs_update = false;
+ info.changed_at = tick.this_run();
+ }
+ }
}
}
}
diff --git a/crates/screens/tests/screens/entity_scope.rs b/crates/screens/tests/screens/entity_scope.rs
index 73666c5..d04139b 100644
--- a/crates/screens/tests/screens/entity_scope.rs
+++ b/crates/screens/tests/screens/entity_scope.rs
@@ -6,6 +6,9 @@ use itertools::Itertools;
use crate::prelude::*;
+// TODO: Test that screens which spawn entities in `load` are able to access those entities.
+// Don't run `load` until all the scoped entities are removed!
+
#[derive(Component, PartialEq, Debug, Copy, Clone)]
#[component(on_insert = Self::on_insert)]
enum Target {
diff --git a/crates/screens/tests/screens/lifecycle.rs b/crates/screens/tests/screens/lifecycle.rs
index 3cc05a6..afefa2f 100644
--- a/crates/screens/tests/screens/lifecycle.rs
+++ b/crates/screens/tests/screens/lifecycle.rs
@@ -53,7 +53,12 @@ macro_rules! impl_test_fns {
}
}
-gen_test_fns!(on_screen_load, on_screen_ready, on_screen_unloaded);
+gen_test_fns!(
+ on_screen_load,
+ on_screen_ready,
+ on_screen_unloaded,
+ on_screen_cleanup
+);
macro_rules! progress_by {
($name:ident) => {
@@ -115,18 +120,6 @@ impl Screen for LifecycleScreen {
commands.write_message(AppExit::error());
}
},
- |r: Res, r2: Res, mut commands: Commands| {
- let ok = r.ok() && r2.ok();
- if ok {
- info!("OK!");
- commands.write_message(AppExit::Success);
- } else {
- error!("Did not reach all expected points.");
- error!(?r);
- error!(?r2);
- commands.write_message(AppExit::error());
- }
- },
)
.chain(),
);
@@ -141,6 +134,27 @@ fn lifecycle() {
app.register_screen::();
app.init_resource::();
app.init_resource::();
- impl_test_fns!(app, on_screen_load, on_screen_ready, on_screen_unloaded);
+ impl_test_fns!(
+ app,
+ on_screen_load,
+ on_screen_ready,
+ on_screen_unloaded,
+ on_screen_cleanup
+ );
+ app.add_systems(
+ on_screen_ready::(),
+ |r: Res, r2: Res, mut commands: Commands| {
+ let ok = r.ok() && r2.ok();
+ if ok {
+ info!("OK!");
+ commands.write_message(AppExit::Success);
+ } else {
+ error!("Did not reach all expected points.");
+ error!(?r);
+ error!(?r2);
+ commands.write_message(AppExit::error());
+ }
+ },
+ );
assert!(app.run().is_success());
}
--
2.51.2
From 553c1cedd34b5e5bf0e9f82875a8b7b650f0f051 Mon Sep 17 00:00:00 2001
From: ada
Date: Sun, 8 Feb 2026 14:43:43 -0600
Subject: [PATCH 5/6] successfully integrate console
---
crates/app/src/service/dev/console/ui.rs | 37 ++++++++++--------------
1 file changed, 15 insertions(+), 22 deletions(-)
diff --git a/crates/app/src/service/dev/console/ui.rs b/crates/app/src/service/dev/console/ui.rs
index 2a47e1f..30e30f7 100644
--- a/crates/app/src/service/dev/console/ui.rs
+++ b/crates/app/src/service/dev/console/ui.rs
@@ -5,17 +5,6 @@ use crate::prelude::*;
use bevy::input_focus::InputFocus;
use q_cmd_prompt::prelude::*;
-fn on_switch_screen(
- trigger: On,
- screens: Screens,
- mut prompts: Query<&mut ConsolePrompt>,
-) {
- for mut prompt in &mut prompts {
- let screen_name = screens.get_by_id(trigger.to).unwrap().name();
- prompt.0 = format!("<{screen_name}>\n> ");
- }
-}
-
fn toggle_console(
keys: Res>,
mut focus: ResMut,
@@ -51,14 +40,13 @@ fn toggle_console(
// this should really be an observer but AcquireFocus isn't publically accessible
fn on_focus(
focus: Res,
- console: Query<&ConsoleUiSettings>,
+ console: Query>,
mut commands: Commands,
- mut last_focus: Local>,
) {
- let focus_entity = focus.get();
- if *last_focus == focus_entity {
+ if !focus.is_changed() {
return;
}
+ let focus_entity = focus.get();
if let Some(id) = focus_entity
&& console.get(id).is_ok()
{
@@ -66,17 +54,17 @@ fn on_focus(
font_color: LinearRgba::new(1., 1., 1., 1.).into(),
background_color: LinearRgba::new(0., 0., 0., 0.8).into(),
});
- } else if let Some(last_focus) = *last_focus {
- commands.entity(last_focus).insert(ConsoleUiSettings {
- font_color: LinearRgba::new(1., 1., 1., 0.5).into(),
- background_color: LinearRgba::new(0., 0., 0., 0.4).into(),
+ } else {
+ console.iter().for_each(|entity| {
+ commands.entity(entity).insert(ConsoleUiSettings {
+ font_color: LinearRgba::new(1., 1., 1., 0.5).into(),
+ background_color: LinearRgba::new(0., 0., 0., 0.4).into(),
+ });
});
}
- *last_focus = focus_entity;
}
pub fn plugin(app: &mut App) {
- app.add_observer(on_switch_screen);
app.add_systems(PostUpdate, (toggle_console, on_focus).chain());
app.add_systems(Startup, |mut commands: Commands| {
// TODO: Dev overlay should be put into a more generalized editor mod
@@ -96,7 +84,12 @@ pub fn plugin(app: &mut App) {
top: percent(67),
..Default::default()
},
- children![(Name::new("Console"), Visibility::Hidden, Console,)],
+ children![(
+ Name::new("Console"),
+ Visibility::Hidden,
+ Console,
+ ConsolePrompt("\n\n> ".into())
+ )],
)],
));
});
--
2.51.2
From 895498092a495581a14f53c1e29910a199affdd0 Mon Sep 17 00:00:00 2001
From: ada
Date: Sun, 8 Feb 2026 15:11:44 -0600
Subject: [PATCH 6/6] lint
---
crates/app/src/service/dev/console/mod.rs | 5 -----
crates/app/src/service/dev/mod.rs | 1 -
2 files changed, 6 deletions(-)
diff --git a/crates/app/src/service/dev/console/mod.rs b/crates/app/src/service/dev/console/mod.rs
index 6490296..d92e394 100644
--- a/crates/app/src/service/dev/console/mod.rs
+++ b/crates/app/src/service/dev/console/mod.rs
@@ -3,11 +3,6 @@ mod ui;
use crate::prelude::*;
-pub mod prelude {
- pub use super::commands::*;
- pub use super::ui::*;
-}
-
pub fn plugin(app: &mut App) {
app.add_plugins(q_cmd_prompt::ConsolePlugin);
app.add_plugins((ui::plugin, commands::plugin));
diff --git a/crates/app/src/service/dev/mod.rs b/crates/app/src/service/dev/mod.rs
index 48d994d..9fdc77d 100644
--- a/crates/app/src/service/dev/mod.rs
+++ b/crates/app/src/service/dev/mod.rs
@@ -6,7 +6,6 @@ mod console;
mod gizmos;
pub mod prelude {
- pub use super::console::prelude::*;
pub use super::gizmos::prelude::*;
}