https://github.com/zhangsoledad/alchemic_avatar

Creating letter avatar from a name
https://github.com/zhangsoledad/alchemic_avatar

avatar elixir

Last synced: 3 months ago
JSON representation

Creating letter avatar from a name

• Host: GitHub
• URL: https://github.com/zhangsoledad/alchemic_avatar
• Owner: zhangsoledad
• License: mit
• Created: 2016-04-05T09:13:30.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T05:54:35.000Z (about 2 years ago)
• Last Synced: 2024-10-13T13:38:06.707Z (3 months ago)
• Topics: avatar, elixir
• Language: Elixir
• Homepage: https://hex.pm/packages/alchemic_avatar
• Size: 101 KB
• Stars: 56
• Watchers: 2
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Elixir library for generating letter avatar from string. (Images)
• fucking-awesome-elixir - alchemic_avatar - Elixir library for generating letter avatar from string. (Images)
• awesome-elixir - alchemic_avatar - Elixir library for generating letter avatar from string. (Images)

README

        
# 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

                

## 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: "static",             # default is "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"

```