https://github.com/rmehri01/thock

⌨️ A modern TUI typing game featuring online racing against friends.
https://github.com/rmehri01/thock

brick haskell tui typing-practice websockets

Last synced: about 2 months ago
JSON representation

⌨️ A modern TUI typing game featuring online racing against friends.

• Host: GitHub
• URL: https://github.com/rmehri01/thock
• Owner: rmehri01
• License: mit
• Created: 2020-11-04T05:58:22.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-26T03:00:12.000Z (almost 4 years ago)
• Last Synced: 2025-04-07T05:43:00.434Z (about 2 months ago)
• Topics: brick, haskell, tui, typing-practice, websockets
• Language: Haskell
• Homepage:
• Size: 1.1 MB
• Stars: 93
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# thock

![GitHub Actions Status](https://github.com/rmehri01/thock/workflows/Build/badge.svg) [![Hackage](https://img.shields.io/hackage/v/thock.svg)](https://hackage.haskell.org/package/thock)

![An example of an online game](resources/demo.gif)

## Installation

### Binary

Right now there are only binaries for Ubuntu and macOS under [releases](https://github.com/rmehri01/thock/releases). Unfortunately there is no support for Windows but the Ubuntu binary will still work in [WSL](https://docs.microsoft.com/en-us/windows/wsl/about).

To use the binary you will have to put it on your PATH and may have to change permissions using `chmod` or allowing it in system preferences.

### From Source

```console

git clone https://github.com/rmehri01/thock.git

cd thock

stack install thock

```

## Usage

 | English/Haskell | Russian | Description | Game State

 | - | - | - | -

 | `Esc`        | `Esc`        | go back | Any

 | `^r`         | `^к`         | retry | Practice

 | `^n / Enter` | `^т / Enter` | next quote | Practice

 | `r`          | `к`          | signal your readiness | Online game waiting room

## Credit

The terminal UI is made using the amazing [brick](https://github.com/jtdaugherty/brick/) library and the online functionality was done using [websockets](https://github.com/jaspervdj/websockets). I also took a great amount of inspiration from other great projects such as [hascard](https://github.com/Yvee1/hascard), [monkeytype](https://github.com/Miodec/monkeytype), and [gotta-go-fast](https://github.com/callum-oakley/gotta-go-fast).