Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paarthmadan/cube

A tui for cube timing, written in Rust.
https://github.com/paarthmadan/cube

cube-timer multithreading rust termion tui tui-rs

Last synced: about 1 month ago
JSON representation

A tui for cube timing, written in Rust.

Host: GitHub
URL: https://github.com/paarthmadan/cube
Owner: paarthmadan
Created: 2020-04-14T21:01:56.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-09-12T22:49:12.000Z (almost 3 years ago)
Last Synced: 2024-07-11T07:40:03.971Z (about 2 months ago)
Topics: cube-timer, multithreading, rust, termion, tui, tui-rs
Language: Rust
Homepage:
Size: 620 KB
Stars: 29
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-ratatui - cube timer - A tui for cube timing, written in Rust. (💻 Apps / 🌌 Other)

README

        # Cube Timer

A tui-based Rubik's cube timer written in _Rust_.

![Cube demo](assets/cube.png)

![Cube demo in larger TMUX session](assets/setup.png)

#### Instructions (pre-release)

```sh

git clone https://github.com/paarthmadan/cube && cd cube

cargo install --path .

cube

```

1. Press Space to begin and end a solve

2. Press q to exit the process

Still heavily in development – proper build and release instructions will be added shortly.

#### Feature List

- [x] Timer

- [x] Basic TUI

- [x] Scramble generator

- [x] Statistics

- [x] Solve graph

- [x] Persisting data across sessions (data written to `~/.cube/data.json`)

#### Not yet implemented

- [ ] Minimizing CPU usage

- [ ] Toggling between different cube sessions

- [ ] Custom configuration (colours etc.)

- [ ] Optimizing UI for different frame sizes (right now it's ideally used in a small tmux pane off to the side :/)

#### How does it work?

- Built on top of the [tui-rs](https://github.com/fdehau) crate.

- The process itself is really a glorified timer:

  - There are a few threads:

    - Keyboard Input

    - Redraw Interrupt Dispatcher

- Communication between threads uses basic message passing – Rust has a nice paradigm for this called [mpsc](https://doc.rust-lang.org/std/sync/mpsc/).

- The main thread performs blocked-waiting for interrupts (events) spawned by other threads. Starvation isn't an issue because the redraw interrupt is dispatched at a fixed interval.

- The [tick rate for the process is currently set to 50](https://github.com/paarthmadan/cube/blob/master/src/event_handler.rs#L52), which would mean the process exhibits roughly 20FPS, which is sufficient.

#### Motivation

- Practicing Rust

- Applying some of the fundamentals learned from Operating Systems

- Now I don't have to open my browser everytime I feel like cubing