akartui-rs

https://github.com/G36maid/akartui-rs.git

# akartui-rs

A Rust-based terminal user interface (TUI) implementation of the **Akari (Light Up)** logic puzzle.

This project uses [ratatui](https://github.com/ratatui-org/ratatui) for rendering the UI, and provides a playable and interactive Akari puzzle game with archive support and keyboard navigation.

---

## Getting Started

### Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) (version 1.70 or later recommended)

- Terminal with UTF-8 support

### Clone and Run

```bash

git clone https://github.com/G36maid/akartui-rs.git

cd akartui-rs

cargo run --release

````

## App Layout

### Overall Structure

```

+--------------------------------------------------------+

| Puzzle Info (ID, Type, Author, Size, Source, Notes...) |

+----------------------+---------------------------------+

| Archive List (1~750) | Puzzle View / Menu / Settings   |

|                      |                                 |

+----------------------+---------------------------------+

| Controls Hint Bar (contextual)                         |

+--------------------------------------------------------+

```

  * Light Up is played on a rectangular grid of white and black cells. The player places light bulbs in white cells such that no two bulbs shine on each other, until the entire grid is lit up. A bulb sends rays of light horizontally and vertically, illuminating its entire row and column unless its light is blocked by a black cell. A black cell may have a number on it from 0 to 4, indicating how many bulbs must be placed adjacent to its four sides; for example, a cell with a 4 must have four bulbs around it, one on each side, and a cell with a 0 cannot have a bulb next to any of its sides. An unnumbered black cell may have any number of light bulbs adjacent to it, or none. Bulbs placed diagonally adjacent to a numbered cell do not contribute to the bulb count.

---

## License and Puzzle Sources

Puzzle data is based on the [Janko.at Akari Collection](https://www.janko.at/Raetsel/Akari/). Many puzzles were created by the Janko team and are published under:

> Creative Commons 3.0: Attribution – Non-Commercial – Share Alike

Some puzzles are used with permission from original authors. If you are a rights holder and would like attribution or removal, please contact us.

---

## Screenshots

*(Coming soon)*

---

## Credits

* TUI library: [ratatui](https://github.com/ratatui-org/ratatui)

* Puzzles: [Janko.at](https://www.janko.at/Raetsel/Akari/)