Skip to content
On this page
Sponsor

Open Peeps

This implementation is a remix of Open Peeps by Pablo Stanley. Licensed under CC0 1.0.

LICENSE

While our code is MIT licensed, the design is licensed under CC0 1.0. See details for more information.

Usage

Options

seed

Type string

The seed determines the initial value for the built-in PRNG. With the PRNG you can create the same avatar over and over again based.

flip

Type boolean

rotate

Type integerMinimum 0Maximum 360

scale

Type integerMinimum 0Maximum 200

radius

Type integerMinimum 0Maximum 50

size

Type integerMinimum 1

backgroundColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

backgroundType

Type array

backgroundRotation

Type array

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as the rotation degree. The rotation is only visible if backgroundType is set to ['gradientLinear'].

translateX

Type integerMinimum -100Maximum 100

translateY

Type integerMinimum -100Maximum 100

clip

Type boolean

randomizeIds

Type boolean

This option randomize the IDs in the generated SVG / XML. This can be useful for example if the avatars are included directly in the HTML and you want to avoid ID collisions.

accessories

Type array

accessoriesProbability

Type integerMinimum 0Maximum 100

clothingColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

face

Type array

facialHair

Type array

facialHairProbability

Type integerMinimum 0Maximum 100

head

Type array

headContrastColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

mask

Type array

maskProbability

Type integerMinimum 0Maximum 100

skinColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

Details

Naming
Collection Import
import { openPeeps } from '@dicebear/collection';
Package Import
import * as style from '@dicebear/open-peeps';
CLI
dicebear openPeeps
HTTP-APIhttps://api.dicebear.com/5.x/open-peeps/svg
Source
TitleOpen Peeps
CreatorPablo Stanley
Websitehttps://twitter.com/pablostanley
LicenseCC0 1.0
Sourcehttps://www.openpeeps.com/