# multihex

> A module that uses ImageMagick to recolor graphical chat avatars

Latest version **1.0.0** (published 2019-11-13) · MIT license · 0 weekly downloads

## Install

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

## 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.0 |
| Published | 2019-11-13 |
| First published | 2019-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 26.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ven Sedlacek |
| Maintainers | datadoodle |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2019-11-13

## README

# Multihex

Multihex is a small module for recoloring specially-formatted chat avatar images (sometimes called "tricolor" or "hexcolor"). It uses Node.js and ImageMagick.

This code has currently only been tested on Ubuntu-based operating systems; more support coming later. It will likely work elsewhere (especially on other Linux OSes) but try at your own risk.

This program is free to use but [donations are always appreciated!](https://ko-fi.com/nventous)

* [Installation](#installation)
* [Functions](#functions)
* [Examples](#examples)
* [Formatting images for Multihex](#formatting-images-for-multihex)
* [License](#license)

---

## Installation

1. Download the source code- `git clone https://github.com/clsedlacek/multihex.git` or use the "Clone or download" link above.

2. Install Node.js dependencies with npm `npm install`

3. Install [ImageMagick](https://imagemagick.org/index.php) (this comes preinstalled on many systems- to check if it's available first, try `convert --version`).

---

## Functions

### multihex

Recolors a single image with given color data

Usage: `multihex(inputFilePath, colorData, options).then(function(res) { ... });`

Returns a string with the path to the recolored image

#### Params

| Param | Type | Description |
| ----- | ---- | ----------- |
| inputFilePath | string | Path to template image |
| colorData | array<object> | Array of colors to target on the template image (see color data section) |
| options | object | Options hash (see options below) |

#### Options

| Property | Type | Description |
| -------- | ---- | ----------- |
| outputDir (optional) | string | Path to directory for output image (uses same directory as input if undefined) |
| outputFileName (optional) | string | Output file name (uses a default name if undefined) |

---

### batchMultihex

Batch recolors multiple images with the same color data

Usage: `batchMultihex(inputFilePaths, colorData, options).then(function(res) { ... });`

Returns an array of strings containing the recolored image paths

#### Params

| Param | Type | Description |
| ----- | ---- | ----------- |
| inputFilePaths | array<string> | Array of paths to template images (as strings) |
| colorData | array<object> | Array of colors to target on the template image (see color data section |
| options | object | Options hash (see options below) |

#### Options

| Property | Type | Description |
| -------- | ---- | ----------- |
| outputDir (optional) | string | Path to directory for output image (uses same directory as input if undefined) |
| outputFileSuffix (optional) | string | Suffix to append to output file names (uses a default `_mhx` if undefined) |

---

## Examples

Process a 6-color image with `multihex.multihex()`:

```
const multihex = require('./multihex');

// path to input (template) image
const templatePath = (__dirname + '/templateavatar.gif');

// color data is in hex format
const colorDataHex = [
	{
		templateHex: '#ff0000', // from red
		targetHex: '#aaaaaa' // to light grey
	},
	{
		templateHex: '#ffff00', // from yellow
		targetHex: '#aa00aa' // to purple
	},
	{
		templateHex: '#00ff00', // from green
		targetHex: '#33ffff' // to cyan
	},
	{
		templateHex: '#00ffff', // from cyan
		targetHex: '#00cc00' // to green
	},
	{
		templateHex: '#0000ff', // from blue
		targetHex: '#eecc00' // to yellow
	},
	{
		templateHex: '#ff00ff', // from magenta
		targetHex: '#007700' // to green
	}
];

const options = {
	outputDir: (__dirname + '/'),
	outputFileName: 'avatar_recolor.gif'
};

multihex.multihex(templatePath, colorDataHex, options).then(res => {
	console.log('Conversion finished! Recolored image at '+res);
	// 'Conversion finished! Recolored image at /projectdir/avatar_recolor.gif'
});

```

---

## Formatting images for Multihex

Better documentation coming soon- meanwhile, [refer to the following tutorial infographic](https://www.deviantart.com/amusedinsanity/art/Tricolor-Hexacolor-Pose-Tutorial-for-CS4-206687253) for creating images compatible with Multihex (thank you to amusedinsanity for creating this tutorial!)

---

## License

Multihex uses the MIT license.

```
Copyright 2019 Ven Sedlacek

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

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