<!-- Source: https://www.dicebear.com/styles/clay/ -->
<!-- Documentation for DiceBear 10.6.1. The complete docs as one file: https://www.dicebear.com/llms-full.txt -->

# Clay

Clay is a soft vector avatar style of rounded lumps that look pinched from
modeling clay, with simple faces, small horns or curls on top, and pressed-in
surface marks. Generate warm SVG profile icons for chat apps and community
profiles.

- **Style name:** `clay`
- **Category:** Characters
- **Animated:** yes
- **Creator:** DiceBear (https://www.dicebear.com)
- **Source:** https://www.dicebear.com
- **License:** CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/)

## Usage

Every library below produces the same SVG for the same seed and options.

HTTP API:

```
https://api.dicebear.com/10.x/clay/svg?seed=John
```

JavaScript:

```
npm install @dicebear/core @dicebear/styles --save
```

```js
import { Style, Avatar } from '@dicebear/core';
import definition from '@dicebear/styles/clay.json' with { type: 'json' };

const style = new Style(definition);
const avatar = new Avatar(style, { seed: 'John' });

const svg = avatar.toString();
```

PHP:

```
composer require dicebear/core dicebear/styles
```

```php
<?php

use Composer\InstalledVersions;
use DiceBear\Style;
use DiceBear\Avatar;

$basePath = InstalledVersions::getInstallPath('dicebear/styles');
$style = Style::fromJson(file_get_contents($basePath . '/src/clay.json'));

$avatar = new Avatar($style, ['seed' => 'John']);

$svg = (string) $avatar;
```

Python:

```
pip install dicebear-core dicebear-styles
```

```python
from importlib.resources import files

from dicebear import Avatar, Style

style = Style.from_json(
    files("dicebear_styles").joinpath("clay.json").read_text("utf-8")
)

avatar = Avatar(style, {"seed": "John"})

svg = avatar.to_string()
```

Rust:

```
cargo add dicebear-core serde_json
cargo add dicebear-styles --features clay
```

```rust
use dicebear_core::{Avatar, Style};
use serde_json::json;

let style = Style::from_str(dicebear_styles::CLAY)?;
let avatar = Avatar::new(&style, json!({ "seed": "John" }))?;

let svg = avatar.to_svg();
```

Go:

```
go get github.com/dicebear/dicebear-go/v10
go get github.com/dicebear/styles/v10
```

```go
import (
	dicebear "github.com/dicebear/dicebear-go/v10"
	"github.com/dicebear/styles/v10"
)

style, _ := dicebear.NewStyle([]byte(styles.Clay))
avatar, _ := dicebear.NewAvatar(style, map[string]any{"seed": "John"})

svg := avatar.SVG()
```

Dart:

```
dart pub add dicebear_core dicebear_styles
```

```dart
import 'package:dicebear_core/dicebear_core.dart';
import 'package:dicebear_styles/clay.dart';

final style = Style.parse(clay);
final avatar = Avatar(style, {'seed': 'John'});

final svg = avatar.svg;
```

CLI:

```
npm install --global dicebear
```

```
dicebear clay
```

## Presets

12 ready-made option sets for this style. Each is a plain set of
render options: pass it to any of the libraries or send it as HTTP-API query
parameters. You do not need to install anything for them, and any option a
preset leaves out keeps varying with the seed.

- **Bare:** No head piece, no surface pattern.
- **Sepia:** One warm brown ramp, background included.
- **Greyscale:** No hue on body, accent or ground.
- **Duotone:** One blue body on one pale ground.
- **Cool:** Blues, greens and violets only.
- **Warm:** Rust, ochre and rose only.
- **Electric:** Neon bodies, quiet ground.
- **Bold Pop:** Saturated ground behind an earthy body.
- **Night Shift:** Dark room, unchanged bodies.
- **Sunrise:** A warm gradient behind the body.
- **Close Up:** The body scaled up, shadow cropped away.
- **Animated:** Turns the style's built-in animation on.

The full option set of each one is at https://www.dicebear.com/styles/clay/presets/index.md.

## Options

Every option below works in all libraries and as a query parameter of the HTTP
API. The ones built from a component name (`<component>Variant`,
`<component>Probability`) or from a color group (`<group>Color`,
`<group>ColorFill`, `<group>ColorFillStops`, `<group>ColorAngle`,
`<group>ColorOrder`) belong to this style; the rest are
[core options](https://www.dicebear.com/guides/core-options/) that every style accepts.

| Option | Type | Values |
| --- | --- | --- |
| `seed` | string |  |
| `size` | number | 1 to 4096 |
| `idRandomization` | boolean |  |
| `title` | string |  |
| `flip` | enum (array allowed) | `none`, `horizontal`, `vertical`, `both` |
| `fontFamily` | string (array allowed) |  |
| `fontWeight` | number (array allowed) | 1 to 1000 |
| `scale` | range | 0 to 10 |
| `borderRadius` | range | 0 to 50 |
| `rotate` | range | -360 to 360 |
| `translateX` | range | -1000 to 1000 |
| `translateY` | range | -1000 to 1000 |
| `topVariant` | enum (array allowed) | `antenna`, `crest`, `curl`, `ears`, `horns`, `hornsSmall`, `loop`, `nub`, `peak`, `pellet`, `spikes`, `swirl`, `tuft` |
| `topProbability` | number | 0 to 100 |
| `bodyVariant` | enum (array allowed) | `bell`, `blob`, `boulder`, `column`, `cube`, `dollop`, `egg`, `gumdrop`, `lean`, `loaf`, `pear`, `slug`, `squat`, `stack` |
| `bodyProbability` | number | 0 to 100 |
| `patternVariant` | enum (array allowed) | `buttons`, `checker`, `coil`, `freckles`, `patch`, `pellets`, `prints`, `spiral`, `stitches`, `zig` |
| `patternProbability` | number | 0 to 100 |
| `eyesVariant` | enum (array allowed) | `big`, `dots`, `down`, `even`, `googly`, `happy`, `inward`, `mono`, `outward`, `pinprick`, `side`, `tiny`, `trio`, `up`, `wink` |
| `eyesProbability` | number | 0 to 100 |
| `mouthVariant` | enum (array allowed) | `cat`, `dot`, `frown`, `grin`, `laugh`, `line`, `o`, `open`, `openSmall`, `pout`, `smile`, `smileBig`, `smileTongue`, `smirk`, `teeth`, `tongue`, `toothy`, `uu`, `wavy`, `zigzag` |
| `mouthProbability` | number | 0 to 100 |
| `animationVariant` | enum (array allowed) | `fast`, `fastest`, `medium`, `none`, `slow`, `slowest` |
| `animationProbability` | number | 0 to 100 |
| `backgroundColor` | color (array allowed) | Hex color, `#` optional |
| `backgroundColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `backgroundColorFillStops` | range |  |
| `backgroundColorAngle` | range | -360 to 360 |
| `backgroundColorOrder` | enum | `random`, `fixed` |
| `bodyColor` | color (array allowed) | Hex color, `#` optional |
| `bodyColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `bodyColorFillStops` | range |  |
| `bodyColorAngle` | range | -360 to 360 |
| `bodyColorOrder` | enum | `random`, `fixed` |
| `accentColor` | color (array allowed) | Hex color, `#` optional |
| `accentColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `accentColorFillStops` | range |  |
| `accentColorAngle` | range | -360 to 360 |
| `accentColorOrder` | enum | `random`, `fixed` |
| `inkColor` | color (array allowed) | Hex color, `#` optional |
| `inkColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `inkColorFillStops` | range |  |
| `inkColorAngle` | range | -360 to 360 |
| `inkColorOrder` | enum | `random`, `fixed` |
| `tags` | enum (array allowed) | `animation` (further values allowed) |

The same table is available as JSON at
`https://api.dicebear.com/10.x/clay/options.json`, and the
raw definition at
`https://api.dicebear.com/10.x/clay/definition.json`.