# AlchemicAvatar

[![Build Status](https://travis-ci.org/zhangsoledad/alchemic_avatar.svg?branch=master)](https://travis-ci.org/zhangsoledad/alchemic_avatar?branch=master)
[![Inline docs](http://inch-ci.org/github/zhangsoledad/alchemic_avatar.svg?branch=master)](http://inch-ci.org/github/zhangsoledad/alchemic_avatar)

Creating letter avatar from user's name(or any other strong / character).
>Inspired by [letter_avatar](https://github.com/ksz2k/letter_avatar).

## Examples

#### Google's Inbox Palette

![example](https://cloud.githubusercontent.com/assets/5518/13031513/43eefa76-d30b-11e5-8f06-85f8eb2a4fb6.png)
![example](https://cloud.githubusercontent.com/assets/5518/13031514/43ef6d8a-d30b-11e5-9fbc-38ae526b56b3.png)
![example](https://cloud.githubusercontent.com/assets/5518/13031517/43f0da12-d30b-11e5-8fef-6c7daf235a54.png)
![example](https://cloud.githubusercontent.com/assets/5518/13031515/43f0568c-d30b-11e5-95c5-1653361d4443.png)
![example](https://cloud.githubusercontent.com/assets/5518/13031519/44382430-d30b-11e5-96e4-bcd7ce5eb155.png)

## Installation
System requirements

```bash
$ sudo apt-get install -y imagemagick
```

Mac OS X

```bash
$ brew install imagemagick ghostscript
```

Add alchemic_avatar to your list of dependencies in `mix.exs`:
```
def deps do
  [{:alchemic_avatar, "~> 0.1.0"}]
end
```

Ensure alchemic_avatar is started before your application:
```
def application do
  [applications: [:alchemic_avatar]]
end
```

## Configuration

```
config :alchemic_avatar,
  cache_base_path: "priv/static",        # default is "priv/static"
  colors_palette: :iwanthue,             # default is :google
  weight: 500,                           # default is 300
  annotate_position: "-0+10"             # default is -0+5
  app_name: #your app name(required)
```
#### Color palette

We have two color palettes implemented: `iwanthue` and `google`.

Each of them have different colors, but the `iwanthue` also differently calculates the color for specified username.

The `google` selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but `iwanthue` will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.

## Usage

```
AlchemicAvatar.generate 'ksz2k', 200
=> "public/system/alchemic_avatar/k/155_206_95/200.png"
```

### Way to support chinese hanzi
```bash
# Translate chinese hanzi to pinyin
# https://github.com/zhangsoledad/alchemic_pinyin
iex> Pinyin.from_string("龡龢龣龤龥癩")
"chui he jue xie yu la"
```