https://github.com/thecentury/brickudoku

A terminal interface for Brickudoku
https://github.com/thecentury/brickudoku

brick game haskell terminal-game tui vty

Last synced: 7 months ago
JSON representation

A terminal interface for Brickudoku

• Host: GitHub
• URL: https://github.com/thecentury/brickudoku
• Owner: Thecentury
• License: mit
• Created: 2023-04-21T20:26:51.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-18T21:07:58.000Z (over 2 years ago)
• Last Synced: 2025-01-25T15:27:04.462Z (8 months ago)
• Topics: brick, game, haskell, terminal-game, tui, vty
• Language: Haskell
• Homepage:
• Size: 2.94 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Brickudoku [![Build Status](https://github.com/thecentury/brickudoku/actions/workflows/haskell-ci.yml/badge.svg)](https://github.com/thecentury/brickudoku/actions/workflows/haskell-ci.yml)

[![Hackage](https://img.shields.io/hackage/v/brickudoku.svg?logo=haskell)](https://hackage.haskell.org/package/brickudoku)

[![Stackage Lts](https://stackage.org/package/brickudoku/badge/lts)](https://stackage.org/lts/package/brickudoku)

[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A terminal interface for Brickudoku game — a hybrid of Sudoku and Tetris.

![brickudoku gameplay](./docs/im/../img/brickudoku-gameplay.gif)

Built on top of the [brick](https://github.com/jtdaugherty/brick) library which makes building terminal user interfaces very accessible. Sam Tay also has a nice [tutorial](https://samtay.github.io/posts/introduction-to-brick) that can help you get started.

## Installlation

### Install from source

First [get stack](https://docs.haskellstack.org/en/stable/#how-to-install). Then

```bash

git clone https://github.com/Thecentury/brickudoku.git

cd brickudoku

stack build

# run using stack

stack run

# alternatively, copy the executable to ~/.local/bin

stack install brickudoku

brickudoku

```

Windows support is unfortunately questionable, but you can try building it in [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).

## Usage

Run the game by simply executing the `brickudoku` command.

## Development

To run the tests,

```bash

stack test

```

To see the test tree in TUI,

```bash

stack test --test-arguments "--tui"

```

## To-do

### Must have

- [ ] Package and publish (to Hackage?)

### Nice to have

- [ ] Initialize the game with a custom seed