https://github.com/georgik/esp32-spooky-maze-game
Rust Bare Metal implementation of maze game for ESP32
https://github.com/georgik/esp32-spooky-maze-game
bare-metal desktop embedded-graphics esp32 rust sdl2 wasm
Last synced: 3 months ago
JSON representation
Rust Bare Metal implementation of maze game for ESP32
- Host: GitHub
- URL: https://github.com/georgik/esp32-spooky-maze-game
- Owner: georgik
- License: mit
- Created: 2022-07-26T01:41:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T14:50:20.000Z (6 months ago)
- Last Synced: 2025-02-27T09:13:03.299Z (4 months ago)
- Topics: bare-metal, desktop, embedded-graphics, esp32, rust, sdl2, wasm
- Language: Rust
- Homepage:
- Size: 954 KB
- Stars: 33
- Watchers: 3
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/ci/build-esp32-firmware.sh
Awesome Lists containing this project
- awesome-esp-rust - esp32-spooky-maze-game - Bare metal Rust implementation of game for different ESP32 based boards using Bevy ECS no_std. (Projects / `no_std`)
README
# esp32-spooky-maze-game
[](https://wokwi.com/projects/380658681618693121)
Spooky Maze is simple game where ghost is located in the maze. The goal is to collect 100 coins.
The ghost can find artifact "Walker" which allows him to pass throght the wall for limited period of time.
The ghost can use dynamite to clear wall in the vicinity. The ghost can use also Teleport spell to move to random place in the maze.
The Teleport spell requires some time to recharge. There are some not friendly spirits running around the maze, when collision occurs the ghost is teleported and loses five coins which are then send randomly back to the maze.
## Flashing binary from Releases
Binaries are available in [GitHub Releases](https://github.com/georgik/esp32-spooky-maze-game/releases).
Binaries can be flashed by:
- CLI [espflash](https://github.com/esp-rs/espflash) `espflash write-bin 0x0 spooky-maze-esp-wrover-kit.bin`
## IDE support
### Rust Rover
Recommendation: Open whole project and attach to particular Cargo.toml for specific target.
## Build and flash
Install `espflash` which is required to flash and monitor the app on Embedded Device:
```
cargo install espflash
```
Enter the directory with project and build it:
```
cd esp32-s3
cargo build --release --features esp32-s3-box-3
```
## Wokwi simulation in VS Code
Open subdirectory with target in VS Code with installed Wokwi Extension. Select `Wokwi: Start Simulator`.
### Build WASM version
```
cd wasm
npm install
npm run serve
```
Open in web browser: https://localhost:8443.
Note: https is required for access to accelerometer data - https://w3c.github.io/deviceorientation/#security-and-privacy . It's possible to run the app without accelerometer on http.
## Implemented technologies
Each directory contains implementation specific for the HW.
Overview:
| Name | Chip | Display | Controls | PMU | GPIO Expander |
|----------------------|----------|----------|---------------------------------------|---------|---------------|
| esp-wrover-kit | esp32 | ili9341 | 6 push-button controls, separate PINs | | |
| esp32-c3-devkit-rust | esp32-c3 | st7789 | icm42670 accelerometer | | |
| esp32-c3-lcdkit | esp32-c3 | gc9a01 | rotary encoder | | |
| esp32-c6-devkit | esp32-c6 | ili9341 | resistor ladder with push buttons | | |
| esp32-s2-kaluga | esp32-s2 | ili9341 | resistor ladder with push buttons | | |
| esp32-s3-box | esp32-s3 | ili9342c | icm42670 accelerometer | | |
| esp32-s3-box-lite | esp32-s3 | st7789 | no controls | | |
| esp32-s3-usb-otg | esp32-s3 | st7789 | 5 push-buttons on the board | | |
| m5stack-core2 | esp32 | ili9341 | mpu6886 accelerometer | axp192 | |
| m5stack-cores32 | esp32-s3 | ili9342c | bmi279 accelerometer | axp2101 | aw9523 |
| m5stack-fire | esp32 | ili9342c | mpu9250 accelerometer | | |
| waveshare-c6-lcd-1-47| esp32c6 | ili9341 | | | |
### Build for ESP32-S3-BOX-3 with ILI9486
Control: IMU
- tilt the board to move the character
- move quickly up to teleport
- move quickly down to place dynamite and destroy walls around
```
cd esp32-s3
cargo run --release --features esp32-s3-box-3
```
### Build for ESP32-C3-DeviKit-RUST with ILI9341
Control: IMU
- tilt board to move character
```
cd esp32-c3
cargo run --release --features esp32-c3-devkit-rust
```
#### Features
- Embedded Graphics
- Framebuffer
- Random maze generator
- IMU Accelerometer control
### Build for ESP32-C3-LcdKit
Control: rotary encoder
- rotate encoder to move the character
- press the encoder to switch the direction
```
cd esp32-c3
cargo run --release --features esp32-c3-lcdkit
```
### Build for desktop
Control: keyboard
- press arrows or W,A,S,D to move the character
- press Enter to teleport
- macOS prerequisites:
```
brew install SDL2
export LIBRARY_PATH="$LIBRARY_PATH:$(brew --prefix)/lib"
```
- OpenSUSE Linux prerequisites:
```
sudo zypper install SDL2-devel
```
- run:
```
cd desktop
cargo run
```
### Build for ESP32-S3-USB-OTG with ST7789
Control: buttons
- press button to move the character
- press up & down to teleport
- press ok & menu to place dynamite
```
cd esp32-s3
cargo run --release --features esp32-s3-usb-otg
```
### Build for M5Stack-FIRE with ESP32 and ILI9341
HW: https://docs.makerfactory.io/m5stack/core/fire/
Control: MPU-9250, buttons
- tilt the board to move the character
- move quickly up or press button C to teleport
- move quickly down or press button B to place dynamite and destroy walls around
```
cd esp32
cargo run --release --features m5stack-fire
```
- Wokwi project: https://wokwi.com/projects/350825213595746900
### Build for M5Stack-Core2 with ESP32 and ILI9342C
HW: https://shop.m5stack.com/products/m5stack-core2-esp32-iot-development-kit?variant=35960244109476
Control: MPU6886
- tilt the board to move the character
- move quickly up or press button C to teleport
- move quickly down or press button B to place dynamite and destroy walls around
```
cd esp32
cargo run --release --features m5stack-core2
```
### Build for ESP32-S2-Kaluga v1.3
HW: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-wrover-kit.html
Control: buttons (partialy implemented based on of https://github.com/espressif/esp-bsp/blob/master/esp32_s2_kaluga_kit/esp32_s2_kaluga_kit.c#L59)
- more details https://github.com/espressif/esp-bsp/blob/master/esp32_s2_kaluga_kit/include/bsp/esp32_s2_kaluga_kit.h#L299
- K3-K6 to move the character
- (not supported) press K5 button to teleport
- (not supported) press K6 button to place dynamite
```
cd esp32-s2
cargo run --release --features esp32-s2-kaluga
```
Note for older version 1.2 - GPIO6 is used to control backlight.
### Build for ESP32-C6-DevKitM-1
HW: https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html
Controls: not implemented
```
cd esp32-c6
cargo run --release --features esp32-c6-devkitc-1
```
### Build for Waveshare C6 LCD 1.47inch
HW: https://www.waveshare.com/esp32-c6-lcd-1.47.htm
Controls: not implemented
```
cd esp32-c6
cargo run --release --features waveshare-esp32-c6-lcd-1-47
```
### Build for ESP Wrover Kit
HW: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/esp32/get-started-wrover-kit.html
Control: 6 push buttons
- it's not possible to move the character
- press button Boot to teleport
```
cd esp32
cargo run --release --features esp32-wrover-kit
```
## Board Support Package (BSP)
The project is using [ESP-BSP-RS](https://crates.io/crates/esp-bsp) which provides macros with preconfigured
GPIOs for a specific board.