Add support for M5Stack Atom S3 (#81)

* m5stack atom s3

Author: georgik

.github/workflows/build-esp32-s3-rust.yml renamed to .github/workflows/build-esp32-s3-box-3-rust.yml

@@ -34,9 +34,7 @@ jobs:
       - name: Run checks
         working-directory: spooky-maze-esp32-s3-box-3
         run: |
-
-          # Perform common checks
           echo "Running common checks"
           cargo fmt --all -- --check --color always
-          #cargo clippy --release --workspace -- -D warnings
-          #cargo build --release
+          cargo clippy --release --workspace -- -D warnings
+          cargo build --release

.github/workflows/build-m5stack-atom-s3-rust.yml

@@ -0,0 +1,40 @@
+name: CI for ESP32-S3
+
+on:
+  push:
+    paths:
+      - "spooky-maze-m5stack-atom-s3/**"
+      - "spooky-core/**"
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  rust-checks:
+    name: Rust Checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Rust (Xtensa)
+        uses: esp-rs/[email protected]
+        with:
+          default: true
+          version: '1.85.0'
+          buildtargets: esp32s3
+          ldproxy: false
+
+      - name: Enable caching
+        uses: Swatinem/rust-cache@v2
+
+      - name: Run checks
+        working-directory: spooky-maze-m5stack-atom-s3
+        run: |
+          echo "Running common checks"
+          cargo fmt --all -- --check --color always
+          cargo clippy --release --workspace -- -D warnings
+          cargo build --release

README.md

@@ -13,23 +13,27 @@ are dispatched to decouple hardware-specific logic from game rules.
 View the video [here](https://github.com/user-attachments/assets/28ef7c2b-42cc-4c79-bbdb-fcb0740bf533).
 </video>
 
-## Screenshots
-
-### Embedded Version - ESP32-S3-BOX-3
-![Spooky Maze Game ESP32-S3-BOX-3](assets/screenshot/spooky-maze-esp32-s3-box-3.webp)
-
-### Desktop Version - macOS
-![Spooky Maze Game Desktop](assets/screenshot/spooky-maze-desktop.webp)
 
 ## Targets
 
 For now, the project supports two primary targets:
 
 - Desktop Rust Standard Version
   Use keyboard controls to move the ghost and trigger actions.
-- ESP32-S3-BOX-3 Embedded Version
+ 
+  ![Spooky Maze Game Desktop](assets/screenshot/spooky-maze-desktop.webp)
+
+- [ESP32-S3-BOX-3](https://github.com/espressif/esp-box) Embedded Version
   Uses an ICM42670 accelerometer for input (tilt the board to move the ghost).
 
+  ![Spooky Maze Game ESP32-S3-BOX-3](assets/screenshot/spooky-maze-esp32-s3-box-3.webp)
+
+- [M5Stack-Atom-S3](https://docs.m5stack.com/en/core/AtomS3) Embedded Version
+  Uses an MPU6886 accelerometer for input (tilt the board to move the ghost).
+
+  ![Spooky Maze Game M5Stack-Atom-S3](assets/screenshot/spooky-maze-m5stack-atom-s3.webp)
+
+
 Note: For older targets (e.g., ESP32-C3, ESP32-S2, etc.), please refer to the [v0.10.0 tag](https://github.com/georgik/esp32-spooky-maze-game/tree/v0.10.0).
 
 ## Key Technical Decisions
@@ -71,7 +75,11 @@ Movement: Arrow keys
 
 ### Embedded Version
 
-#### ESP32-S3-BOX-3
+#### ESP32-S3
+
+These instructions are valid for boards based on ESP32-S3:
+- ESP32-S3-BOX-3
+- M5Stack-Atom-S3
 
 Prerequisites:
 
@@ -95,15 +103,22 @@ source esp-idf/export.sh
 
 Properly configured ESP32-S3-BOX-3 hardware
 
-Build:
+Build and run:
 
+- ESP32-S3-BOX-3
 ```shell
 cd spooky-maze-esp32-s3-box-3
 cargo run --release
 ```
+- M5Stack-Atom-S3
+```shell
+cd spooky-maze-m5stack-atom-s3
+cargo run --release
+```
+
 Controls:
 
-Movement: Tilt the board (using the ICM42670 accelerometer)
+Movement: Tilt the board accelerometer
 
 ## Differences of Embedded Bevy no_std from Classical Bevy std
 

assets/screenshot/spooky-maze-m5stack-atom-s3.webp

@@ -1,7 +1,6 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
 // Expose modules for the core logic.
-mod camera;
 pub mod components;
 pub mod events;
 pub mod maze;

spooky-core/src/camera.rs

@@ -5,7 +5,6 @@
 #[cfg(feature = "dynamic_maze")]
 use maze_generator::{prelude::*, recursive_backtracking::RbGenerator};
 
-use bevy::prelude::Vec;
 use rand::prelude::*;
 use rand_chacha::ChaChaRng;
 

spooky-core/src/lib.rs

@@ -2,7 +2,7 @@ use embedded_graphics::pixelcolor::Rgb565;
 use embedded_graphics::prelude::RgbColor;
 use embedded_graphics::{
     geometry::{OriginDimensions, Size},
-    prelude::{DrawTarget, Pixel, Point},
+    prelude::{DrawTarget, Pixel},
 };
 use embedded_graphics_framebuf::FrameBuf;
 use embedded_graphics_framebuf::backends::FrameBufferBackend;

spooky-core/src/maze.rs

@@ -18,7 +18,7 @@ pub fn detect_coin_collision(
 
     for coin in maze_res.maze.coins.iter() {
         if coin.x == player_tile_x && coin.y == player_tile_y {
-            event_writer.send(CoinCollisionEvent {
+            event_writer.write(CoinCollisionEvent {
                 coin_x: coin.x,
                 coin_y: coin.y,
             });
@@ -46,7 +46,7 @@ pub fn remove_coin_on_collision(
         // Despawn coin entity with matching coordinates.
         for (entity, coin_comp) in query.iter() {
             if coin_comp.x == event.coin_x && coin_comp.y == event.coin_y {
-                commands.entity(entity).despawn_recursive();
+                commands.entity(entity).despawn();
             }
         }
     }

spooky-core/src/sprite_buf.rs

@@ -19,7 +19,7 @@ pub fn detect_dynamite_collision(
     // Dynamites are stored in an array (e.g., [Coin; 1])
     for dynamite in maze_res.maze.dynamites.iter() {
         if dynamite.x == player_tile_x && dynamite.y == player_tile_y {
-            event_writer.send(DynamiteCollisionEvent {
+            event_writer.write(DynamiteCollisionEvent {
                 x: dynamite.x,
                 y: dynamite.y,
             });

spooky-core/src/systems/collisions/coin.rs

@@ -1,7 +1,5 @@
 use crate::components::Player;
 use crate::events::npc::NpcCollisionEvent;
-use crate::maze::Coin; // needed for coin operations
-use crate::maze::Npc;
 use crate::resources::{MazeResource, PlayerPosition};
 use crate::transform::UnifiedTransform;
 use bevy::prelude::*;
@@ -18,7 +16,7 @@ pub fn detect_npc_collision(
 
     for npc in maze_res.maze.npcs.iter() {
         if npc.x == player_tile_x && npc.y == player_tile_y {
-            event_writer.send(NpcCollisionEvent {
+            event_writer.write(NpcCollisionEvent {
                 npc_x: npc.x,
                 npc_y: npc.y,
             });

spooky-core/src/systems/collisions/dynamite.rs

@@ -1,6 +1,5 @@
 use crate::components::WalkerComponent;
 use crate::events::walker::WalkerCollisionEvent;
-use crate::maze::Coin;
 use crate::resources::{MazeResource, PlayerPosition};
 use bevy::prelude::*; // Assumes you have a WalkerComponent
 
@@ -18,7 +17,7 @@ pub fn detect_walker_collision(
     // Iterate over all walker positions stored in the maze.
     for walker in maze_res.maze.walkers.iter() {
         if walker.x == player_tile_x && walker.y == player_tile_y {
-            event_writer.send(WalkerCollisionEvent {
+            event_writer.write(WalkerCollisionEvent {
                 walker_x: walker.x,
                 walker_y: walker.y,
             });

spooky-core/src/systems/collisions/npc.rs

@@ -1,5 +1,3 @@
-#![no_std]
-
 use bevy::prelude::*;
 
 /// A resource storing the current HUD values.

spooky-core/src/systems/collisions/walker.rs

@@ -1,4 +1,6 @@
-use crate::components::{MainCamera, Player};
+#[cfg(not(feature = "std"))]
+use crate::components::MainCamera;
+use crate::components::Player;
 use crate::events::player::PlayerInputEvent;
 use crate::resources::{MazeResource, PlayerPosition};
 use bevy::prelude::*;

spooky-core/src/systems/hud.rs

@@ -1,16 +1,16 @@
 // Common Bevy imports.
-use crate::components::{CoinComponent, NpcComponent, Player};
+use crate::components::Player;
+#[cfg(feature = "std")]
+use crate::components::{CoinComponent, NpcComponent};
 use crate::maze::Maze;
 use crate::resources::{MazeResource, MazeSeed, PlayerPosition};
 use bevy::prelude::*;
 use bevy_math::Vec3;
-use bevy_transform::prelude::{GlobalTransform, Transform};
+use bevy_transform::prelude::Transform;
 
 // When compiling for desktop (std enabled), use Bevy's AssetServer and its Image type.
 #[cfg(feature = "std")]
 use bevy::image::Image;
-#[cfg(feature = "std")]
-use bevy::prelude::*;
 
 // --- TextureAssets for asset loading ---
 #[cfg(feature = "std")]
@@ -187,7 +187,7 @@ pub fn setup(
                     Sprite::from_image(textures.coin.clone()),
                     Transform::from_translation(Vec3::new(coin.x as f32, coin.y as f32, 2.0)),
                     // (Assuming you have a CoinComponent for collision detection)
-                    crate::components::CoinComponent {
+                    CoinComponent {
                         x: coin.x,
                         y: coin.y,
                     },
@@ -247,9 +247,9 @@ pub fn setup(
     }
 
     // <-- NEW: Spawn NPCs.
+    #[cfg(feature = "std")]
     for (i, npc) in maze_for_entities.npcs.iter().enumerate() {
         if npc.x != -1 && npc.y != -1 {
-            #[cfg(feature = "std")]
             {
                 // Choose an appropriate z-coordinate (e.g., 5.0) so that NPCs are drawn in front of coins
                 // but behind the player if that’s your design.
@@ -263,22 +263,22 @@ pub fn setup(
                     },
                 ));
             }
-            #[cfg(not(feature = "std"))]
-            {
-                // (No action or custom handling for no_std)
-            }
         }
     }
 
     // Spawn the full tile map (background) covering the maze.
+    #[cfg(feature = "std")]
     let margin: i32 = Maze::MARGIN;
+    #[cfg(feature = "std")]
     let total_width = maze_for_entities.width as i32 + 2 * margin;
+    #[cfg(feature = "std")]
     let total_height = maze_for_entities.height as i32 + 2 * margin;
+    #[cfg(feature = "std")]
     for ty in 0..total_height {
         for tx in 0..total_width {
             let mx = tx - margin;
             let my = ty - margin;
-            #[cfg(feature = "std")]
+
             let texture = if mx >= 0
                 && my >= 0
                 && mx < maze_for_entities.width as i32

spooky-core/src/systems/process_player_input.rs

@@ -1,4 +1,3 @@
-use bevy::input::keyboard::KeyboardInput;
 use bevy::prelude::*;
 use spooky_core::events::player::PlayerInputEvent;
 
@@ -27,6 +26,6 @@ pub fn dispatch_keyboard_input(
     }
 
     if dx != 0.0 || dy != 0.0 {
-        event_writer.send(PlayerInputEvent { dx, dy });
+        event_writer.write(PlayerInputEvent { dx, dy });
     }
 }

spooky-core/src/systems/setup.rs

@@ -5,7 +5,6 @@ use icm42670::Icm42670;
 use icm42670::prelude::*;
 use spooky_core::events::player::PlayerInputEvent;
 use spooky_core::resources::MazeResource;
-use spooky_core::resources::PlayerPosition;
 
 /// A resource wrapping the accelerometer sensor.
 /// (This resource is non‑Send because the sensor’s driver isn’t Sync.)
@@ -36,7 +35,7 @@ pub fn dispatch_accelerometer_input<I2C, E>(
             dy = if accel.y > 0.0 { step } else { -step };
         }
         if dx.abs() > f32::EPSILON || dy.abs() > f32::EPSILON {
-            event_writer.send(PlayerInputEvent { dx, dy });
+            event_writer.write(PlayerInputEvent { dx, dy });
         }
     }
 }

spooky-maze-desktop/src/desktop_systems/player_input.rs

@@ -1,7 +1,5 @@
 use alloc::format;
-#[cfg(not(feature = "std"))]
 use embedded_graphics::pixelcolor::Rgb565;
-#[cfg(not(feature = "std"))]
 use embedded_graphics::{image::Image, prelude::*, primitives::Rectangle};
 
 use bevy_ecs::prelude::*;
@@ -10,7 +8,6 @@ use embedded_graphics::mono_font::ascii::FONT_6X10;
 use embedded_graphics::text::Text;
 use spooky_core::resources::{MazeResource, PlayerPosition};
 use spooky_core::systems::hud::HudState;
-#[cfg(not(feature = "std"))]
 use spooky_core::systems::setup::TextureAssets;
 
 /// A borrowed sprite buffer wrapper that implements a DrawTarget filtering out “magic pink”.
@@ -65,9 +62,9 @@ pub fn render_system(
     mut display_res: NonSendMut<crate::DisplayResource>,
     mut fb_res: ResMut<crate::FrameBufferResource>,
     maze_res: Res<MazeResource>,
-    #[cfg(not(feature = "std"))] texture_assets: Res<TextureAssets>,
-    #[cfg(not(feature = "std"))] player_pos: Res<PlayerPosition>,
-    #[cfg(not(feature = "std"))] hud_state: Res<HudState>,
+    texture_assets: Res<TextureAssets>,
+    player_pos: Res<PlayerPosition>,
+    hud_state: Res<HudState>,
 ) {
     // Clear the framebuffer.
     fb_res.frame_buf.clear(Rgb565::BLACK).unwrap();

spooky-maze-esp32-s3-box-3/src/embedded_systems/player_input.rs

@@ -1,7 +1,5 @@
 use alloc::boxed::Box;
-use embedded_graphics::pixelcolor::Rgb565;
 use embedded_graphics::prelude::*;
-use embedded_graphics_framebuf::FrameBuf;
 use embedded_graphics_framebuf::backends::FrameBufferBackend;
 
 // ------------------------------------------------------------------------------------