https://github.com/CamiloGarciaLaRotta/kboard

Terminal game to practice keyboard typing
https://github.com/CamiloGarciaLaRotta/kboard

bubbletea game go terminal

Last synced: 29 days ago
JSON representation

Terminal game to practice keyboard typing

• Host: GitHub
• URL: https://github.com/CamiloGarciaLaRotta/kboard
• Owner: CamiloGarciaLaRotta
• License: gpl-3.0
• Created: 2020-10-25T18:24:50.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-06-05T08:56:46.000Z (over 1 year ago)
• Last Synced: 2024-06-20T12:09:03.068Z (4 months ago)
• Topics: bubbletea, game, go, terminal
• Language: Go
• Homepage:
• Size: 110 KB
• Stars: 182
• Watchers: 2
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• charm-in-the-wild - kboard - A typing game. (_built with Bubble Tea_) (Applications / Games)

README

        
![noun_Keyboard_3563522](https://user-images.githubusercontent.com/17187770/97167613-7d81fb80-175d-11eb-9f0c-2c335d666d85.png)

# kboard

Terminal game to practice keyboard typing. Built with [bubbletea](https://github.com/charmbracelet/bubbletea)

### Install

#### Golang

```bash

go get github.com/CamiloGarciaLaRotta/kboard

```

#### Homebrew

```

brew install camilogarcialarotta/brews/kboard

```

### How to use

```bash

kboard [number] [time]

number: the number of words to generate. Must be a non-zero positive integer.

        defaults to 1 word.

time:   the number of seconds that the game will last.

        If none is passed, tha game finishes after the first word.

Examples:

 - kboard 2

 - kboard 1 30

 ```

### Untimed mode

![untimed demo](https://user-images.githubusercontent.com/17187770/97325058-f611b680-1848-11eb-8b3b-d80660a8ded4.gif)

### Timed mode

![timed demo](https://user-images.githubusercontent.com/17187770/97336421-5e669500-1855-11eb-8d4c-1683a771c0e6.gif)