[Bevy]: https://bevyengine.org/
[COPYING]: ./COPYING
[Codeberg]: https://codeberg.org/cacilhas/nonogram
[Crates.io]: https://crates.io/crates/kodumaro-nonogram
[Itch.io]: https://cacilhas.itch.io/nonogram
[Nonogram]: https://codeberg.org/cacilhas/nonogram/raw/branch/master/assets/nonogram.png
[Rust]: https://www.rust-lang.org/
[The 3-Clause BSD License]: https://opensource.org/licenses/BSD-3-Clause
[UPX]: https://upx.github.io/

# Kodumaro Nonogram

![Nonogram][]

A simple random nonogram game.

Related pages:
- [Itch.io][]
- [Crates.io][]
- [Codeberg][]
- [Bevy][]
- [Rust][]

## Install

Install release:

```sh
cargo install kodumaro-nonogram
```

Install nightly:

```sh
cargo install --git=https://codeberg.org/cacilhas/nonogram.git kodumaro-nonogram
```

If you have [UPX][] installed, you may want to try:

```sh
upx --best --lzma ~/.cargo/bin/nonogram
```

## Gameplay

- Left click (LMB): set the cell
- Right click (RMB), or C-LMB, or ⌘-LMB: mark a cell as unsettable
- Middle click (MMB) or ⇧-LMB: mark the cell as possibly settable
- LMB on a set cell: unset it
- RMB on an unsettable cell: make it settable
- MMB on a cell marked as possibly settable: unmark it
- R key: reset current board
- Escape: quit current game
- Pause: pause the game
- C-Q or ⌘-Q: quit the app

You win when you have set all correct cells, matching the sums of the rows and
columns.

## License

- [The 3-Clause BSD License][]
- [COPYING][]

License: BSD-3-Clause
