https://github.com/ethereum/blockies

<1k library that generates blocky identicons
https://github.com/ethereum/blockies

Last synced: 3 months ago
JSON representation

<1k library that generates blocky identicons

• Host: GitHub
• URL: https://github.com/ethereum/blockies
• Owner: ethereum
• Archived: true
• Fork: true (download13/blockies)
• Created: 2015-10-09T13:56:37.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-03-27T15:23:27.000Z (over 2 years ago)
• Last Synced: 2024-09-22T07:01:58.694Z (3 months ago)
• Language: JavaScript
• Size: 250 KB
• Stars: 398
• Watchers: 6
• Forks: 285
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - ethereum/blockies - <1k library that generates blocky identicons (JavaScript)
• awesome-identicons - Blockies

README

        
Blockies

========

A tiny library for generating identicons for Ethereum addresses. These are not meant to replace user profiles, but as security icons, to allow the user to more easily check if an address he wants to interact with is the correct one. The symmetrical aspect of the icons allow our brain see [faces or objects](https://en.wikipedia.org/wiki/Pareidolia), making the icon more recognizable. This also contains the HQX library, for optionally creating not-so-blocky icons (see sample below).

![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/)