termitype

Just another rusty TUI typing game
Development · Installation

Development

Getting Started

1. Clone the repository:

git clone https://github.com/emanuel2718/termitype.git
cd termitype

2. Optional: Install theme Pack

# NOTE: This is only required for local development. In production, this is handled automatically by the build process.
./scripts/install-themes.sh

3. Build and run:

# Normal run
cargo run

# Debug mode
cargo run -- --debug

Installation

cargo install termitype@0.0.1-alpha.25

TODO

• Locally track stats (results) with sqlite (can be opted-out with termitype --no-track)
• Release on:
  • crates.io
  • Homebrew
  • AUR
  • nixpkgs

Done

• Layout cleanup pass
• Settings persistance
• Proper Results screen
• Build Github CI
• Theme swap at runtime (Menu -> Themes -> )
• Theme preview in menu
• Change cursor style via cli
• Change cursor style at runtime
• Only show (3) lines with scroll off
• underline wrong words (must have at least one wrong character for it to be underlined)
• Add scrolbar to the menu
• Preview the cusror style change like we do with the theme picker
• Change language at runtime
• Add more languages and word lists (good enough for now)
• Change mode/value with the menu
• Fetch themes at build time from iterm2Themes url
• Don't include debug flag in release
• Add LICENSE