# imagemosaick

> Mosaic image generation utility using ImageMagick

Latest version **1.0.3** (published 2017-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install imagemosaick
pnpm add imagemosaick
yarn add imagemosaick
bun add imagemosaick
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-12-24 |
| First published | 2017-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | brian.holley@hotmail.com |
| Maintainers | brianholley |
| Keywords | mosaic, image, imagemagick |

## Links

- npm: https://www.npmjs.com/package/imagemosaick
- Repository: https://github.com/brianholley/imagemosaick
- Homepage: https://github.com/brianholley/imagemosaick#readme
- Issues: https://github.com/brianholley/imagemosaick/issues
- npm.io page: https://npm.io/package/imagemosaick

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^3.1.0
- [rgb-to-hsl](https://npm.io/package/rgb-to-hsl.md) 0.0.3
- [use-strict](https://npm.io/package/use-strict.md) ^1.0.1
- [imagemagick](https://npm.io/package/imagemagick.md) ^0.1.3

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2017-12-24
- 1.0.1 — 2017-12-23
- 1.0.0 — 2017-12-22

## README

# imagemosaick
Image mosaic generation library using imagemagick

[![Build Status](https://travis-ci.org/brianholley/imagemosaick.svg?branch=master)](https://travis-ci.org/brianholley/imagemosaick)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Installation

```
npm install imagemosaick
```

## Usage

```javascript
var mosaick = require('imagemosaick')

let tilesFolder = './tileset'
let tileSize = 16
var tileset = new mosaick.Tileset(
    tilesFolder,
    tileSize)

let input = 'inputFile.png'
let output = 'outputFile.png'
let options = { }
mosaick.generate(input, output, tileset, options)
    .then(() => { console.log('Finished!') })
```

## Options

Mosaic generation curently supports the following options:

| Option        | Description | Default |
| ------------- | ----------- | ------- |
| verbose       | Enable verbose stdout logging | false |
| verboseEx     | Enable extra verbose stdout logging (VERY verbose) | false |
| maxMosaicSize | Maximum mosaic size in # of tiles (scale source image down to fit if necessary) | 200 |
| threshold     | Hue match threshold (0-320) - how far should the color match go? | 60 |

---
_Source: https://npm.io/package/imagemosaick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
