CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

[0.5.0] - 2026-03-21

🚀 Features

Mousefood now supports configurable cursor styles and text blinking!

• (backend) Add modifier and blink support (#172)

See the documentation for more information.

• (backend) Add lilygo t5 e-paper support (#180)
• (backend) Make "underline-color" feature optional (#166)

📚 Documentation

• (esp32-no-std-demo) Add note about SPI mode and display size (#169)
• (readme) Add AirSniffer project (#173)
• (esp32-std-demo) Add setup information (#171)
• (examples) Add STM32 Nucleo L433RC-P example (#177)

[0.4.0] - 2026-02-09

🚀 Features

• (demo) Add esp32-no-std demo example (#158)

🚜 Refactor

• (backend) [breaking] Remove framebuffer from the public API (#149)
• (examples) Improve the esp32-std-demo (#157)

📚 Documentation

• (readme) List display drivers tested by the community (#155)
• (readme) Recommend disabling framebuffer for EPD drivers (#162)

⚡ Performance

• (framebuffer) Avoid cloning during flush for every frame (#153)

⚙️ Miscellaneous Tasks

• (esp32-no-std) Use tui-bigtext for voltage UI (#159)

[0.3.0] - 2026-01-28

Mousefood now depends on Ratatui 0.30 and supports no_std environments!

🚀 Features

• (backend) Make framebuffer optional via feature flag (#119)
• (backend) Support clearing when framebuffer is disabled (#147)
• (backend) Support epd_waveshare (#127)
• (backend) Support color themes (#136)
• (backend) Add display/display_mut methods to EmbeddedBackend (#122)
• (simulator) [breaking] Removed simulator feature (#83)
• (framebuffer) Export framebuffer to be consumed by integration crates (#105)
• [breaking] Configurable terminal alignment (#110)

🐛 Bug Fixes

• Default to white on black when converting to BinaryColor (#111)
• Expose TerminalAlignment for library users (#113)
• Don't reset to regular font when bold or italic is None (#125)

📚 Documentation

• (readme) Add bold and italic fonts section
• (readme) Update info about no-std compatibility (#89)
• (readme) Update simulator section (#97)
• (readme) Add simulator screenshot (#99)
• (error) Fix link to ratatui_core::backend::ClearType enum (#102)
• (readme) Add projects made with mousefood (#124)
• (project) Update links to the repository
• (contributing) Add contribution guidelines (#77)
• (examples) Improve examples in the documentation (#145)
• (readme) Update tested devices (#148)

⚡ Performance

• (fonts) Use font atlas for faster lookups (#123)

⚙️ Miscellaneous Tasks

• Workspace setup (#75)

[0.2.1] - 2025-04-23

🚜 Refactor

• (examples) Remove unnecessary extern crate from simulator example

📚 Documentation

• (readme) Fix simulator code snippet

⚙️ Miscellaneous Tasks

• (examples) Configure simulator example in Cargo.toml
• Update list of excluded paths in Cargo.toml

[0.2.0] - 2025-04-15

🚀 Features

• (no_std) Use core/alloc instead of std where possible
• (config) Add option to set a flush callback
• WeAct Studio epaper modules support

🚜 Refactor

• Break down lib.rs into backend.rs, colors.rs, default_font.rs and error.rs
• (examples) Change text1 to text
• Simplify color conversion
• [breaking] Add config struct instead of multiple backend constructors
• (backend) Simplify modifier parsing

📚 Documentation

• (readme) Add information about planned no_std support
• (examples) Add missing docs in simulator example
• (assets) Add epd-weact.jpg
• (readme) Add EPD support section
• (readme) Add link to ratatui no_std tracking issue

🧪 Testing

• (colors) Add color conversion tests
• (framebuffer) Add framebuffer tests

⚙️ Miscellaneous Tasks

• Configure dependabot
• (lint) Add std instead of core/alloc lints
• Add test job to CI workflow
• Ignore .idea

[0.1.0] - 2025-03-29

🚀 Features

• (simulator) [breaking] embedded-graphics-simulator support and example using simulator feature
• (backend) [breaking] Simplify EmbeddedBackend::new constructor and add EmbeddedBackend::with_font for creating a backend with custom font
• (buffer) Implement a simple heap-allocated framebuffer
• (fonts) Use custom fonts with better unicode support
• (simulator) Re-export embedded_graphics_simulator as simulator, when using simulator crate feature

🐛 Bug Fixes

• Simplify draw function
• Handle errors

🚜 Refactor

• (examples) Make use of re-exports in simulator example

📚 Documentation

• Correct markdown mistakes
• (readme) Update usage section after api changes
• (readme) Add simulator section
• (readme) Add logo to README.md
• (readme) Remove redundant horizontal line
• (readme) Update demo images
• (license) Re-license under MIT + Apache 2.0
• (readme) Add Quickstart, Performance and hardware support and Docs sections to README.md
• (api) Add missing api docs

⚙️ Miscellaneous Tasks

• Release workflow
• Ci workflow
• Changelog workflow
• (tools) Add ratatui to list of correct spellings
• (tools) Configure git-cliff
• (tools) Configure markdownlint
• (logo) Add project logo
• Move changelog job to a changelog workflow
• Run crate publish workflow manually
• Run markdownlint ci job only for README.md

[0.0.1] - 2025-03-18

🚀 Features

• Re-export ratatui and embedded-graphics

🐛 Bug Fixes

• Change text on demo image

📚 Documentation

• Initial README.md
• Demo image

⚙️ Miscellaneous Tasks

• Add license
• Update Cargo.toml