Skip to main content

Micah

Sean Moore Lionel Quinn Lydia Ellis Bryan Phelps Ronald Frank Annette Klein Brent Hill Stanley Newman Grace Singleton

Implementation of Avatar Illustration System by Micah Lanier. Licensed under CC BY 4.0.

note

While our code is MIT licensed, the design is licensed under CC BY 4.0. See license overview for more information.

Usage#

HTTP-API (recommended)#

Our free HTTP-API is the easiest way to use this avatar style. Just use the following URL as image source.

https://avatars.dicebear.com/api/micah/:seed.svg

See the HTTP API documentation for more information.

NPM#

Install the Avatars and this avatar style with the following command.

npm install --save @dicebear/avatars @dicebear/micah

Now you are ready to create your first Avatar.

import { createAvatar } from '@dicebear/avatars';
import * as style from '@dicebear/micah';
let svg = createAvatar(style, {
seed: 'custom-seed',
// ... and other options
});

Options#

Base options#

seed

Seed

Alias: s

Default: undefined

Type: string

dataUri

Data URI

Default: false

Type: boolean

flip

Flip

Default: false

Type: boolean

rotate

Rotate

Default: 0

Type: integer

Minimum: 0

Maximum: 360

scale

Scale

Default: 100

Type: integer

Minimum: 0

Maximum: 200

radius

Radius

Alias: r

Default: 0

Type: integer

Minimum: 0

Maximum: 50

size

Size

Default: undefined

Type: integer

Minimum: 1

backgroundColor

Background Color

Alias: b

Default: undefined

Type:

translateX

Translate X%

Default: 0

Type: integer

Minimum: -100

Maximum: 100

translateY

Translate Y%

Default: 0

Type: integer

Minimum: -100

Maximum: 100

Style options#

base

Base

Default: standard

Type: array

Items:

Type: string

Enum: standard

mouth

Mouth

Default: surprised, laughing, nervous, smile, sad, pucker, frown, smirk

Type: array

Items:

Type: string

Enum: surprised, laughing, nervous, smile, sad, pucker, frown, smirk

eyebrows

Eyebrows

Default: up, down, eyelashesUp, eyelashesDown

Type: array

Items:

Type: string

Enum: up, down, eyelashesUp, eyelashesDown

hair

Hair

Default: fonze, mrT, dougFunny, mrClean, dannyPhantom, full, turban, pixie

Type: array

Items:

Type: string

Enum: fonze, mrT, dougFunny, mrClean, dannyPhantom, full, turban, pixie

hairProbability

Hair Probability

Default: 100

Type: integer

Minimum: 0

Maximum: 100

eyes

Eyes

Default: eyes, round, eyesShadow, smiling

Type: array

Items:

Type: string

Enum: eyes, round, eyesShadow, smiling

nose

Nose

Default: curve, pointed, tound

Type: array

Items:

Type: string

Enum: curve, pointed, tound

ears

Ears

Default: attached, detached

Type: array

Items:

Type: string

Enum: attached, detached

shirt

Shirt

Default: open, crew, collared

Type: array

Items:

Type: string

Enum: open, crew, collared

earrings

Earrings

Default: hoop, stud

Type: array

Items:

Type: string

Enum: hoop, stud

earringsProbability

Earrings Probability

Default: 30

Type: integer

Minimum: 0

Maximum: 100

glasses

Glasses

Default: round, square

Type: array

Items:

Type: string

Enum: round, square

glassesProbability

Glasses Probability

Default: 30

Type: integer

Minimum: 0

Maximum: 100

facialHair

Facial Hair

Default: beard, scruff

Type: array

Items:

Type: string

Enum: beard, scruff

facialHairProbability

Facial Hair Probability

Default: 10

Type: integer

Minimum: 0

Maximum: 100

baseColor

Base Color

Default: apricot, coast, topaz

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

earringColor

Earring Color

Default: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

eyeShadowColor

Eye Shadow Color

Default: azure, calm, mellow, seashell, white

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

eyebrowColor

Eyebrow Color

Default: black

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

facialHairColor

Facial Hair Color

Default: topaz

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

glassesColor

Glasses Color

Default: azure, black, calm, canary, lavender, mellow, salmon, seashell, sky, white

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

hairColor

Hair Color

Default: azure, black, calm, canary, lavender, mellow, salmon, seashell, sky, white

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

mouthColor

Mouth Color

Default: black

Type: array

Items:

Type: string

Enum: black

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

shirtColor

Shirt Color

Default: azure, black, calm, canary, lavender, mellow, salmon, seashell, sky, white

Type: array

Items:

Type: string

Enum: apricot, azure, black, calm, canary, coast, lavender, mellow, salmon, seashell, sky, topaz, white

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$