https://github.com/shilangyu/typer-go

Test your typing speed in the terminal! ⌨
https://github.com/shilangyu/typer-go

go golang typer typeracer typing-game typing-speed wpm

Last synced: 2 days ago
JSON representation

Test your typing speed in the terminal! ⌨

• Host: GitHub
• URL: https://github.com/shilangyu/typer-go
• Owner: shilangyu
• License: mit
• Created: 2019-05-26T20:01:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-04T15:47:16.000Z (over 3 years ago)
• Last Synced: 2024-06-19T02:20:32.223Z (4 months ago)
• Topics: go, golang, typer, typeracer, typing-game, typing-speed, wpm
• Language: Go
• Homepage:
• Size: 129 KB
• Stars: 17
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typer-go

[![](https://goreportcard.com/badge/github.com/shilangyu/typer-go)](https://goreportcard.com/report/github.com/shilangyu/typer-go)

[![](https://github.com/shilangyu/typer-go/workflows/ci/badge.svg)](https://github.com/shilangyu/typer-go/actions)

Test your typing speed in a Typer [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) game!

- [typer-go](#typer-go)

	- [features](#features)

	- [install](#install)

	- [usage](#usage)

	- [settings](#settings)

	- [navigation](#navigation)

## features

- collect statistics to track your progress

  - Words per minute

  - Timestamps

  - Amount of mistakes for each word

  - Amount of time for each word

- play with your friends in local multiplayer (global coming soon)

- customizable

- comfort of your sweet sweet terminal

## install

Grab an executable from the [release tab](https://github.com/shilangyu/typer-go/releases)

... or if you're an Gopher build from source (requires Go v1.13+):

```sh

go get github.com/shilangyu/typer-go

```

## usage

Just run `typer-go` in your terminal and the TUI will start. Full screen terminal is recommended. There are no CLI commands and flags.

## settings

| name          | values                     | description                                                                                                                                  |

| ------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |

| highlight     | `'background'` or `'text'` | The way the already typed text should be highlighted. `'background'` to fill the background, `'text'` to just fill the text.                 |

| error display | `'typed'` or `'text'`      | what should be shown when incorrect character is inputted. `'typed'` will show the typed char, `'text'` will show what should've been typed. |

| texts path    | any string                 | path to your custom typer texts where each text is separated by a new line. If path is empty, preloaded texts will be loaded.                |

## navigation

[~~The whole TUI has mouse support!~~](https://github.com/shilangyu/typer-go/issues/9)

| key               | description          |

| ----------------- | -------------------- |

| ↑      | menu navigation up   |

| ↓      | menu navigation down |

| enter  | confirm              |

| esc    | back                 |

| tab    | switch focus         |

| ctrl+c | exit                 |