Skip to content

mzums/typeman

Repository files navigation

TypeMan

Typing speed test with practice mode in GUI, TUI and CLI

Rust Crates.io License: MIT PRs


Alt Text


Alt Text


Alt Text


Alt Text


Alt Text

Installation

Crates.io:

Install the default version (all modes: CLI, GUI, TUI):

cargo install typeman

You can also install only the modes you want by using --no-default-features and specifying features::

  • only TUI:
    cargo install typeman --no-default-features --features tui
    
  • only TUI and CLI:
    cargo install typeman --no-default-features --features "tui cli"
    

Tweaks on installs:

Additional action needed for succesfull install

On MacOS:
cargo install --target x86_64-apple-darwin typeman
On Ubuntu (before installing):
sudo apt-get install libfontconfig1-dev
sudo apt install libasound2-dev
On Fedora (before installing):
sudo dnf install alsa-lib-devel

From source:

1. clone repo

git clone https://github.com/mzums/typeman      

2. enter project

cd typeman

3. run

cargo run

Modes:

  • TUI (ratatui)
  • GUI (macroquad)
  • CLI

CLI parameters:

  • word number: number of displayed words
  • top words: number of top most common english words used to generae test
  • time: duration of the test in time mode
  • quote: random quote
  • punctuation: punctuation in word number and time modes
  • digits: digits in word and time modes
  • level - practice level

Commands:

  • typeman - TUI
  • typeman --gui - GUI
  • typeman --cli - CLI
    • typeman --cli -c ./text.txt - custom file
    • typeman --cli -q - random quote
    • typeman --cli (-t=30) -n=500 - 30s (default) test with random words from 500 most used english words
    • typeman --cli -w=50 -n=500 -p -d - 50 random words from 500 most used english words with punctuation and digits
    • typeman --cli -l - list all practice levels
    • typeman --cli -l=1 - practice first level

Customization:

  • multi-language support
  • multiple themes

Credits:

Special thanks to piter231 for testing!

Releases

No releases published

Packages

No packages published

Contributors 6