Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

30 lines (26 loc) · 1.18 KB

Keep in mind the main purpose of this project is for me to learn some Rust and make a fun game for my kids..

Bug reports and feature requests

If you find a bug or want to submit a feature request, you are most welcome. However, as this is a hobby project of mine, I cannot make any commitments to what extent I will make any efforts to your request. I am definitely interested in any feedback that can improve my command of the Rust programming language.

Helping out

Feel free to to fix a bug yourself or take one of the features from the list below. Discuss with the maintainer first.

Feature roadmap

The below list is in descending order of priority (feel free to convince me to reprioritize):

  • Startup splash screen
  • Add 'Turbo' mode
  • Nicer game over screen showing your score
  • Retain high score
  • Add support for regular USB keyboard
  • Sound feedback
  • Use HDMI output instead of Unicorn Hat HD

Technical roadmap

  • Consider replacing mio by tokio
  • Make configuration file to make input device configurable
  • No longer need to change toml file to cross compile (unicorn hat stuff)
  • EAGAIN in gamepad, is it an issue ?
  • Cleanup of modules/crates/traits
  • Logging
  • Rustdoc
  • Testing