Skip to main content

Open Peeps

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

Implementation of Open Peeps by Pablo Stanley. Licensed under CC0 1.0.

note

While our code is MIT licensed, the design is licensed under CC0 1.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/open-peeps/: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/open-peeps

Now you are ready to create your first Avatar.

import { createAvatar } from '@dicebear/avatars';
import * as style from '@dicebear/open-peeps';
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#

head

Head

Default: afro, bangs, bangs2, bantuKnots, bear, bun, bun2, buns, cornrows, cornrows2, dreads1, dreads2, flatTop, flatTopLong, grayBun, grayMedium, grayShort, hatBeanie, hatHip, hijab, long, longAfro, longBangs, longCurly, medium1, medium2, medium3, mediumBangs, mediumBangs2, mediumBangs3, mediumStraight, mohawk, mohawk2, noHair1, noHair2, noHair3, pomp, shaved1, shaved2, shaved3, short1, short2, short3, short4, short5, turban, twists, twists2

Type: array

Items:

Type: string

Enum: afro, bangs, bangs2, bantuKnots, bear, bun, bun2, buns, cornrows, cornrows2, dreads1, dreads2, flatTop, flatTopLong, grayBun, grayMedium, grayShort, hatBeanie, hatHip, hijab, long, longAfro, longBangs, longCurly, medium1, medium2, medium3, mediumBangs, mediumBangs2, mediumBangs3, mediumStraight, mohawk, mohawk2, noHair1, noHair2, noHair3, pomp, shaved1, shaved2, shaved3, short1, short2, short3, short4, short5, turban, twists, twists2

face

Face

Default: angryWithFang, awe, blank, calm, cheeky, concerned, concernedFear, contempt, cute, cyclops, driven, eatingHappy, explaining, eyesClosed, fear, hectic, lovingGrin1, lovingGrin2, monster, old, rage, serious, smile, smileBig, smileLOL, smileTeethGap, solemn, suspicious, tired, veryAngry

Type: array

Items:

Type: string

Enum: angryWithFang, awe, blank, calm, cheeky, concerned, concernedFear, contempt, cute, cyclops, driven, eatingHappy, explaining, eyesClosed, fear, hectic, lovingGrin1, lovingGrin2, monster, old, rage, serious, smile, smileBig, smileLOL, smileTeethGap, solemn, suspicious, tired, veryAngry

facialHair

Facial Hair

Default: chin, full, full2, full3, full4, goatee1, goatee2, moustache1, moustache2, moustache3, moustache4, moustache5, moustache6, moustache7, moustache8, moustache9

Type: array

Items:

Type: string

Enum: chin, full, full2, full3, full4, goatee1, goatee2, moustache1, moustache2, moustache3, moustache4, moustache5, moustache6, moustache7, moustache8, moustache9

facialHairProbability

Facial Hair Probability

Default: 10

Type: integer

Minimum: 0

Maximum: 100

mask

Mask

Default: medicalMask, respirator

Type: array

Items:

Type: string

Enum: medicalMask, respirator

maskProbability

Mask Probability

Default: 5

Type: integer

Minimum: 0

Maximum: 100

accessories

Accessories

Default: eyepatch, glasses, glasses2, glasses3, glasses4, glasses5, sunglasses, sunglasses2

Type: array

Items:

Type: string

Enum: eyepatch, glasses, glasses2, glasses3, glasses4, glasses5, sunglasses, sunglasses2

accessoriesProbability

Accessories Probability

Default: 20

Type: integer

Minimum: 0

Maximum: 100

skinColor

Skin Color

Default: variant01, variant02, variant03, variant04, variant05

Type: array

Items:

Type: string

Enum: variant01, variant02, variant03, variant04, variant05

or

Type: string

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

clothingColor

Clothing Color

Default: red01, orange01, yellow01, green01, tail01, blue01, pink01

Type: array

Items:

Type: string

Enum: red01, orange01, yellow01, green01, tail01, blue01, pink01

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: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08, variant09, variant10

Type: array

Items:

Type: string

Enum: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08, variant09, variant10

or

Type: string

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