wip: refactor GUI into separate crates

Author: cilki

Cargo.lock

@@ -19,13 +19,24 @@ sandpolis-instance = { path = "../sandpolis-instance", version = "0.0.1" }
 sandpolis-database = { path = "../sandpolis-database", version = "0.0.1" }
 sandpolis-macros = { path = "../sandpolis-macros", version = "0.0.1" }
 sandpolis-core = { path = "../sandpolis-core", version = "0.0.1" }
+sandpolis-network = { path = "../sandpolis-network", version = "0.0.1", optional = true }
+sandpolis-server = { path = "../sandpolis-server", version = "0.0.1", optional = true }
+sandpolis-user = { path = "../sandpolis-user", version = "0.0.1", optional = true }
 native_db = { workspace = true, optional = true }
 native_model = { workspace = true, optional = true }
 
 # GUI dependencies
 bevy = { workspace = true, optional = true }
 bevy_svg = { workspace = true, optional = true, features = ["2d"] }
 bevy_rapier2d = { workspace = true, optional = true }
+bevy_egui = { workspace = true, optional = true }
+bevy_stl = { workspace = true, optional = true }
+egui-file-dialog = { workspace = true, optional = true }
+egui_console = { workspace = true, optional = true }
+egui_extras = { workspace = true, optional = true }
+inventory = { workspace = true }
+tracing = { workspace = true }
+rand = { workspace = true, optional = true }
 
 # TUI dependencies
 ratatui = { workspace = true, optional = true }
@@ -35,7 +46,26 @@ tui-popup = { workspace = true, optional = true }
 
 [features]
 client = ["dep:passwords"]
-client-gui = ["client", "dep:bevy", "dep:bevy_svg", "dep:bevy_rapier2d"]
+client-gui = [
+  "client",
+  "dep:bevy",
+  "dep:bevy_svg",
+  "dep:bevy_rapier2d",
+  "dep:bevy_egui",
+  "dep:bevy_stl",
+  "dep:egui-file-dialog",
+  "dep:egui_console",
+  "dep:egui_extras",
+  "dep:rand",
+  "dep:sandpolis-network",
+  "dep:sandpolis-server",
+  "dep:sandpolis-user",
+  "sandpolis-core/client-gui",
+  "sandpolis-instance/client-gui",
+  "sandpolis-network/client-gui",
+  "sandpolis-server/client-gui",
+  "sandpolis-user/client",
+]
 client-tui = [
   "client",
   "dep:ratatui",

sandpolis-client/Cargo.toml

@@ -1,26 +1,30 @@
+//! About screen with Easter egg activation.
+//!
+//! The about screen can be activated by triple-clicking on the layer indicator.
+
 use bevy::prelude::*;
 use bevy_egui::{EguiContexts, egui};
 use std::time::{Duration, Instant};
 
-/// Resource to track about screen state
+/// Resource to track about screen state.
 #[derive(Resource, Default)]
 pub struct AboutScreenState {
     pub show: bool,
-    /// Tracks clicks on the layer indicator for Easter egg
+    /// Tracks clicks on the layer indicator for Easter egg.
     pub logo_click_count: u8,
     pub last_logo_click: Option<Instant>,
 }
 
-/// Marker component for the 3D logo entity
+/// Marker component for the 3D logo entity.
 #[derive(Component)]
 pub struct AboutLogo;
 
-/// Marker component for the about screen's 3D camera
+/// Marker component for the about screen's 3D camera.
 #[derive(Component)]
 pub struct AboutCamera;
 
-/// Easter egg: Check if the click sequence has timed out
-/// Returns true if we should reset the counter
+/// Easter egg: Check if the click sequence has timed out.
+/// Returns true if we should reset the counter.
 fn should_reset_clicks(last_click: Option<Instant>) -> bool {
     if let Some(last) = last_click {
         last.elapsed() > Duration::from_secs(2)
@@ -29,8 +33,8 @@ fn should_reset_clicks(last_click: Option<Instant>) -> bool {
     }
 }
 
-/// System to handle the Easter egg for opening about screen
-/// Easter egg: Triple-click on the layer indicator within 2 seconds
+/// System to handle the Easter egg for opening about screen.
+/// Easter egg: Triple-click on the layer indicator within 2 seconds.
 pub fn handle_about_easter_egg(mut about_state: ResMut<AboutScreenState>) {
     // Reset click counter if too much time has passed
     if should_reset_clicks(about_state.last_logo_click) {
@@ -39,7 +43,7 @@ pub fn handle_about_easter_egg(mut about_state: ResMut<AboutScreenState>) {
     }
 }
 
-/// Call this from the layer indicator when it's clicked
+/// Call this from the layer indicator when it's clicked.
 pub fn register_logo_click(about_state: &mut AboutScreenState) {
     let now = Instant::now();
 
@@ -58,12 +62,12 @@ pub fn register_logo_click(about_state: &mut AboutScreenState) {
         about_state.last_logo_click = None;
 
         if about_state.show {
-            info!("🥚 Easter egg activated! About screen opened.");
+            info!("Easter egg activated! About screen opened.");
         }
     }
 }
 
-/// System to spawn the 3D logo when about screen is shown
+/// System to spawn the 3D logo when about screen is shown.
 pub fn spawn_about_logo(
     mut commands: Commands,
     about_state: Res<AboutScreenState>,
@@ -131,7 +135,7 @@ pub fn spawn_about_logo(
     }
 }
 
-/// System to rotate the logo slowly backwards
+/// System to rotate the logo slowly backwards.
 pub fn rotate_about_logo(time: Res<Time>, mut logo_query: Query<&mut Transform, With<AboutLogo>>) {
     for mut transform in logo_query.iter_mut() {
         // Rotate backwards (negative rotation around X axis) at a slow speed
@@ -140,7 +144,7 @@ pub fn rotate_about_logo(time: Res<Time>, mut logo_query: Query<&mut Transform,
     }
 }
 
-/// System to render the about screen UI with egui
+/// System to render the about screen UI with egui.
 pub fn render_about_screen(
     mut contexts: EguiContexts,
     mut about_state: ResMut<AboutScreenState>,
@@ -172,7 +176,7 @@ pub fn render_about_screen(
                 // Space for the 3D logo rendering at the top
                 ui.add_space(320.0); // Height of the 3D viewport + padding
 
-                ui.heading("🏰 SANDPOLIS");
+                ui.heading("SANDPOLIS");
                 ui.add_space(8.0);
 
                 ui.label("Security & Systems Management Platform");

sandpolis/src/client/gui/about.rs sandpolis-client/src/gui/about.rssandpolis/src/client/gui/about.rs renamed to sandpolis-client/src/gui/about.rs

@@ -1,4 +1,4 @@
-use super::{components::NodeEntity, edges::Edge};
+use crate::gui::{NodeEntity, edges::Edge};
 use bevy::prelude::*;
 use sandpolis_core::InstanceId;
 

sandpolis/src/client/gui/activity.rs sandpolis-client/src/gui/activity.rssandpolis/src/client/gui/activity.rs renamed to sandpolis-client/src/gui/activity.rs

@@ -1,32 +1,61 @@
+//! Core GUI component definitions.
+//!
+//! This module contains the shared Bevy components and resources used
+//! throughout the GUI system.
+
 use bevy::prelude::*;
-use sandpolis_core::InstanceId;
+use sandpolis_core::{InstanceId, Layer};
 use tokio::sync::mpsc;
 
-/// Marker component for the main world view camera
+/// Only one layer can be selected at a time.
+#[derive(Resource, Deref, DerefMut, Debug)]
+pub struct CurrentLayer(pub Layer);
+
+impl Default for CurrentLayer {
+    fn default() -> Self {
+        Self(Layer::from("Network"))
+    }
+}
+
+/// Current zoom level for the camera.
+#[derive(Resource, Deref, DerefMut)]
+pub struct ZoomLevel(pub f32);
+
+impl Default for ZoomLevel {
+    fn default() -> Self {
+        Self(1.0)
+    }
+}
+
+/// Marker component for the main world view camera.
 #[derive(Component)]
 pub struct WorldView;
 
-/// Component that marks an entity as representing an instance node
+/// Component that marks an entity as representing an instance node.
 #[derive(Component)]
 pub struct NodeEntity {
     pub instance_id: InstanceId,
 }
 
-/// Minimap configuration
+/// Marker component for selected nodes.
+#[derive(Component)]
+pub struct Selected;
+
+/// Component representing a minimap configuration.
 #[derive(Component)]
 pub struct Minimap {
     pub zoom_factor: f32, // How much smaller the minimap view is (e.g., 0.1 for 10x zoom out)
 }
 
-/// Marker component for the minimap camera
+/// Marker component for the minimap camera.
 #[derive(Component)]
 pub struct MinimapCamera;
 
-/// Marker component for layer indicator UI
+/// Marker component for layer indicator UI.
 #[derive(Component)]
 pub struct LayerIndicator;
 
-/// Resource controlling minimap viewport settings
+/// Resource controlling minimap viewport settings.
 #[derive(Resource)]
 pub struct MinimapViewport {
     pub width: f32,
@@ -35,7 +64,7 @@ pub struct MinimapViewport {
 }
 
 impl MinimapViewport {
-    /// Create responsive minimap viewport based on window size
+    /// Create responsive minimap viewport based on window size.
     pub fn from_window_size(window_width: f32, window_height: f32) -> Self {
         // For mobile screens (< 800px width), use smaller minimap
         let is_mobile = window_width < 800.0;
@@ -66,7 +95,7 @@ impl Default for MinimapViewport {
     }
 }
 
-/// Resource for layer indicator state
+/// Resource for layer indicator state.
 #[derive(Resource)]
 pub struct LayerIndicatorState {
     pub show_timer: Timer, // Display for N seconds after layer change
@@ -80,7 +109,7 @@ impl Default for LayerIndicatorState {
     }
 }
 
-/// Database update events from resident listeners
+/// Database update events from resident listeners.
 #[derive(Clone, Debug)]
 pub enum DatabaseUpdate {
     InstanceAdded(InstanceId),
@@ -96,23 +125,19 @@ pub enum DatabaseUpdate {
     TransferCompleted(InstanceId, InstanceId),
 }
 
-/// Resource containing channel receiver for database updates
+/// Resource containing channel receiver for database updates.
 #[derive(Resource)]
 pub struct DatabaseUpdateChannel {
     pub receiver: mpsc::UnboundedReceiver<DatabaseUpdate>,
 }
 
-/// Resource containing channel sender for database updates
+/// Resource containing channel sender for database updates.
 #[derive(Resource, Clone)]
 pub struct DatabaseUpdateSender {
     pub sender: mpsc::UnboundedSender<DatabaseUpdate>,
 }
 
-/// Marker component for selected nodes
-#[derive(Component)]
-pub struct Selected;
-
-/// Resource tracking all currently selected nodes
+/// Resource tracking all currently selected nodes.
 #[derive(Resource, Default)]
 pub struct SelectionSet {
     pub selected_nodes: Vec<InstanceId>,