Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrbjarksen/a-puzzle-a-day
Generate and browse all solutions to A-Puzzle-A-Day
https://github.com/mrbjarksen/a-puzzle-a-day
Last synced: about 1 month ago
JSON representation
Generate and browse all solutions to A-Puzzle-A-Day
- Host: GitHub
- URL: https://github.com/mrbjarksen/a-puzzle-a-day
- Owner: mrbjarksen
- License: gpl-2.0
- Created: 2024-01-06T18:47:13.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-15T20:27:59.000Z (9 months ago)
- Last Synced: 2024-10-06T08:37:09.336Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 348 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - a-puzzle-a-day - Generate and browse all solutions to A-Puzzle-A-Day. (đģ Apps / đšī¸ Games and Entertainment)
README
# A-Puzzle-A-Day
[DragonFjord's A-Puzzle-A-Day](https://www.dragonfjord.com/product/a-puzzle-a-day/)
tasks you with placing eight pieces within a calendar frame
to reveal the current date. There are roughly 60 thousand ways
the pieces can fit in the frame, and of those arrangements
over 24 thousand are valid solutions.
That is an average of 67 solutions per date, and yet some days
solving the puzzle can seem utterly and hopelessly impossible.
This piece of software can serve as a holy light for those
despondent, ego-shattering days, allowing you to generate
and browse all solutions for all days at your leisure.
## Usage
There are three main modes of use: `browse`, `random`, and `generate`.
### Browse
```
$ a-puzzle-a-day browse [-f/--file ] [-d/--date ]
```
Open a TUI showing all solutions. The UI is split into two panes: the date pane (left) and the solution pane (right).
To navigate, use the arrow keys or hjkl. To switch panes, press Tab or Enter. To quit, press Escape or q.
Alternatively, there is full mouse support, including scroll.
Note that colors were chosen with a dark terminal theme in mind. There is currently no way to change colorschemes.
### Random
```
$ a-puzzle-a-day random [-f/--file ] [-d/--date ]
```
This will display a random solution for the current date, or the date specified by
the option `-d` or `--date`.
### Generate
```
$ a-puzzle-a-day generate [-f/--file ]
```
This will generate all solutions and write them to the file `solutions.apad`,
or the file specified by the option `-f` or `--file`
(this file is identical to the solutions file found in this repository).
The file created uses a custom-built binary file format, named [APAD](docs/APAD.md).
Solutions are found using brute-force, each piece placed on each square in parallel.
Care has been made in minimizing the amount of work needed, but the generation will
take at least a few seconds and a few dozen threads.
**Note**: this is generally unnecessary, as the solutions are included
in the binary.
## Installation
This software can be installed using [Cargo](https://doc.rust-lang.org/stable/cargo/),
from the [crates.io](https://crates.io/) registry.
```
$ cargo install a-puzzle-a-day
```
This will place the executable `a-puzzle-a-day` into `$HOME/.cargo/bin`
(by default), which should be added to `$PATH`.
Alternatively, to build from source:
```
git clone https://github.com/mrbjarksen/a-puzzle-a-day
cd a-puzzle-a-day
cargo build --release
cp target/release/a-puzzle-a-day
```