# monkey-nonogram
> a javascript library for creating, solving, and playing nonogram puzzles
Latest version **0.2.1** (published 2022-11-01) · MIT license · 0 weekly downloads
## Install
```sh
npm install monkey-nonogram
pnpm add monkey-nonogram
yarn add monkey-nonogram
bun add monkey-nonogram
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.2.1 |
| Published | 2022-11-01 |
| First published | 2022-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 334.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 54 |
| Author | monkeyArms |
| Maintainers | donbuche |
## Links
- npm: https://www.npmjs.com/package/monkey-nonogram
- Repository: https://github.com/monkeyArms/nonogram
- Issues: https://github.com/monkeyArms/nonogram/issues
- npm.io page: https://npm.io/package/monkey-nonogram
## Recent versions
- 0.2.1 (latest) — 2022-11-01
## README
# nonogram
[](https://choosealicense.com/licenses/mit/)
[]()
A small javascript library for creating, solving, and playing nonogram puzzles.
## About
[Nonograms](https://en.wikipedia.org/wiki/Nonogram) (or "Picross" puzzles, or several other names) are a fun type of visual logic puzzle. If you enjoy Sudoku, Kakuro, or other logic puzzles you might enjoy Nonograms.
The original version of this library was written in the fall of 2016 as a hobby project.
The library has been refactored to use ES6 classes, and eliminated all dependencies such as jQuery, Foundation, FontAwesome, etc.
## Features
- Lightweight (~8KB when gzipped)
- No dependencies
- Fast solving alogorithm that uses logical techniques instead of brute force.
- Can be used stand-alone to generate, parse or solve puzzles.
- Simple, themable GUI (optional)
## Demo
[Live Demo](https://monkeyarms.github.io/nonogram/)
## Basic Usage
(See `example` directory for a simple implementation.)
Place containers to hold the gui elements with `data-nonogram-{x}` attributes. They can be placed anywhere in an HTML layout and none are required:
```html
```
Include nonogram:
```html
```
Create a random 8x8 puzzle and tell the GUI to render everything:
```html
```
## Usage via source ES6 modules
Replace the javascript above with the following:
```html
```
## Theming
Copy the `default` directory in `dist/themes` and rename it to "my-theme", etc. Modify the theme, then tell the GUI to load it in the constructor:
```javascript
const gui = new Gui( './themes/my-theme' );
```
The theme stylesheet is automatically prepended to your pages `` element so that any other stylesheets can override it. Theme templates are loaded asynchronously in the background.
---
_Source: https://npm.io/package/monkey-nonogram · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._