Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 4.4 KB

README.md

File metadata and controls

102 lines (68 loc) · 4.4 KB
Raw

Termtyper icon

Termtyper 🖮

A typing application to level up your fingers!

GitHub issues GitHub stars GitHub license Support Server

Installation 🔨

For Python Users:

You can install termtyper easily using python one-liner

python3 -m pip install git+https://github.com/kraanzu/termtyper.git

Or the long way?

git clone https://github.com/kraanzu/termtyper.git
cd termtyper
pip3 install .

Or maybe You use Arch btw?

paru -S termtyper-git

And then simply type termtyper in your terminal to launch it.. ezy pzy

⚠️ Note: Config file for termtyper is located at your $XDG_CONFIG_HOME (or ~/.config/termtyper)

⚠️ Note: You must use python version >=3.10

Not Familiar with Python?

Visit our Actions page and get Artifacts (all executable files!) from the latest run!

Statues: Python application

Features 🌟

Some features that termtyper comes with:

  • An interactive & beautiful UI
  • Mechanical sounds!
  • Words and Time based typing
  • Real-time comparision of speed carets
  • Racebar themes with typing-speed based colors
  • Change styles/settings on the fly
  • Lots of options to tweak! (See tweaks)

Tweaks ⚙️

Tweak Description
Blind mode You wouldn't be able to see your mistakes
Capital Letters Some letters in your tasks will be capitalized!
Caret Style Caret style matters!
Click Sound Choose the sound you wanna hear when you smack that key!
Confidence mode Are you sure you don't need backspace? Try this :)
Cursor Buddy Setup your cursor buddy to run along with you!
Difficulty Choose how strict termtyper should be with your wrong keypresses
Force Correct You wouldn't be able to able to go on without cleaning your pool of mistakes
Keypress Sound Need sounds while typing? Select your preference here
Min Accuracy Fall below this average accuracy and you fail!
Min Burst Fall below this average accuracy for even a word and you fail!
Min Speed Fall below this average speed and you fail!
Restart Same I won't stop until I clear that passage!
Tab Reset Hey hey! You wanna reset already? I got ya!

That's it fellas (See Contribution if you want something more)

See Demo Video below in order to get a visual :)

Demo 🎥

demo.mp4

Contribution 🤝

  • Want to contribute? Feel free to open a PR! 😸
  • Got some ideas for improvements? I'm all ears! 👂

Other TUI projects 🤓 :

If you liked termtyper then you might wanna try out some of my other TUI projects as well

  • dooit - A todo app that you didn't ask for but needed!
  • gupshup - A localhost TUI chat client