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

# Planets

Planets is a space-themed vector avatar style with a single textured planet,
optional rings and moons, and a star-filled sky. Generate atmospheric SVG
profile icons for dashboards, games, and science apps.

- **Style name:** `planets`
- **Category:** Scenes
- **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/planets/svg?seed=John
```

JavaScript:

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

```js
import { Style, Avatar } from '@dicebear/core';
import definition from '@dicebear/styles/planets.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/planets.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("planets.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 planets
```

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

let style = Style::from_str(dicebear_styles::PLANETS)?;
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.Planets))
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/planets.dart';

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

final svg = avatar.svg;
```

CLI:

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

```
dicebear planets
```

## Presets

8 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.

- **Warm System:** Reds, oranges and golds only.
- **Cool System:** Greens, teals and blues only.
- **Greyscale:** A monochrome sky and a grey planet.
- **Duotone:** One indigo for sky, planet and moon.
- **Muted:** Dusty planets against a deep sky.
- **Electric:** Neon planets on black.
- **Daylight:** A pale sky instead of deep space.
- **Close Up:** Scaled in, so the planet fills the frame.

The full option set of each one is at https://www.dicebear.com/styles/planets/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 |
| `moonsVariant` | enum (array allowed) | `one`, `tiny`, `two` |
| `moonsProbability` | number | 0 to 100 |
| `planetVariant` | enum (array allowed) | `disc` |
| `planetProbability` | number | 0 to 100 |
| `ringVariant` | enum (array allowed) | `bold`, `double`, `thin` |
| `ringProbability` | number | 0 to 100 |
| `shadeVariant` | enum (array allowed) | `hard`, `soft` |
| `shadeProbability` | number | 0 to 100 |
| `surfaceVariant` | enum (array allowed) | `banded`, `belted`, `cap`, `cracked`, `cratered`, `marbled`, `speckled`, `spotted`, `swirl`, `terra` |
| `surfaceProbability` | number | 0 to 100 |
| `starVariant` | enum (array allowed) | `faint`, `large`, `medium`, `small`, `sparkle` |
| `starProbability` | 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` |
| `planetColor` | color (array allowed) | Hex color, `#` optional |
| `planetColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `planetColorFillStops` | range |  |
| `planetColorAngle` | range | -360 to 360 |
| `planetColorOrder` | enum | `random`, `fixed` |
| `moonColor` | color (array allowed) | Hex color, `#` optional |
| `moonColorFill` | enum (array allowed) | `solid`, `linear`, `radial` |
| `moonColorFillStops` | range |  |
| `moonColorAngle` | range | -360 to 360 |
| `moonColorOrder` | 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/planets/options.json`, and the
raw definition at
`https://api.dicebear.com/10.x/planets/definition.json`.