# ethereum-blockies

> A tiny library for generating blocky identicons.

Latest version **0.1.1** (published 2017-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install ethereum-blockies
pnpm add ethereum-blockies
yarn add ethereum-blockies
bun add ethereum-blockies
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-06-12 |
| First published | 2017-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ethereum-blockies) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 406 |
| Author | Erin Dachtler, Alex Van de Sande |
| Maintainers | avsa |

## Links

- npm: https://www.npmjs.com/package/ethereum-blockies
- Repository: https://github.com/alexvandesande/blockies
- Homepage: https://github.com/alexvandesande/blockies#readme
- Issues: https://github.com/alexvandesande/blockies/issues
- npm.io page: https://npm.io/package/ethereum-blockies

## Recent versions

- 0.1.1 (latest) — 2017-06-12
- 0.1.0 — 2017-06-12

## README

Blockies
========

A tiny library for generating blocky identicons.

![Sample blockies image](sample.png "Blockies")

[**Demo page**](http://download13.github.io/blockies/)

Use
---

```javascript
var icon = blockies.create({ // All options are optional
    seed: 'randstring', // seed used to generate icon data, default: random
    color: '#dfe', // to manually specify the icon color, default: random
    bgcolor: '#aaa', // choose a different background color, default: random
    size: 15, // width/height of the icon in blocks, default: 8
    scale: 3, // width/height of each block in pixels, default: 4
    spotcolor: '#000' // each pixel has a 13% chance of being of a third color, 
    // default: random. Set to -1 to disable it. These "spots" create structures
    // that look like eyes, mouths and noses. 
});

document.body.appendChild(icon); // icon is a canvas element
```

In the above example the icon will be 15x15 blocks, and each block will be 3x3 pixels. The icon canvas will be 45x45 pixels.


Notes
-----

The defaults of size 8 and scale 4 generate 32x32 pixel icons. Below are some standard sizes that work well. A size larger than 10 will start generating more noisy icons that don't ressemble much.

 * 24x24 `{size: 8, scale: 3}`
 * 50x50 `{size: 5, scale: 10}`


Build
-----

    node build
All this does is minify `blockies.js` to `blockies.min.js`.


License
-------

[WTFPL](http://www.wtfpl.net/)

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