List of Style Options

[mauricioluz]

Are there a way to get all style options available to a specific style?

[FlorianKoerner]

Hi @mauricioluz

Each avatar style also includes a JSONSchema that we use ourselves to evaluate the available options.

import { schema as coreSchema } from '@dicebear/avatars';
import { schema as styleSchema } from '@dicebear/adventurer';

console.log(coreSchema, styleSchema);

We use this information in the CLI, for example:

dicebear create <avatar-style> --help

• dicebear/packages/dicebear/src/utils/command/makeCreateStyleCommand.ts

  Lines 14 to 39 in 88c396f

  	const schema = mergeAllOf(
  	{
  	allOf: [
  	{
  	properties: {
  	count: {
  	title: 'Count',
  	description: 'Defines how many avatars to create. Does not work in combination with a "seed".',
  	type: 'number',
  	default: 1,
  	},
  	format: {
  	title: 'Format',
  	type: 'string',
  	enum: ['svg', 'png', 'jpg', 'jpeg'],
  	default: 'svg',
  	},
  	},
  	},
  	coreSchema,
  	style.schema,
  	],
  	additionalItems: true,
  	},
  	{ ignoreAdditionalProperties: true }
  	);

• dicebear/packages/dicebear/src/utils/getOptionsBySchema.ts

  Lines 5 to 50 in 88c396f

  	export async function getOptionsBySchema(schema: JSONSchema7) {
  	const result: InstanceType<typeof Option>[] = [];
  	const aliases: string[][] = utils.schema.aliases(schema);
  	for (var key in schema.properties) {
  	if (false === schema.properties.hasOwnProperty(key)) {
  	continue;
  	}
  	const property = schema.properties[key];
  	const names = aliases.find((v) => v.includes(key)) ?? [key];
  	const isPrimary = names[0] === key;
  	if (isPrimary && typeof property === 'object') {
  	const options = names.map((name) => (name.length === 1 ? `-${name}` : `--${name}`));
  	const option = new Option(`${options.join(', ')} <value>`);
  	let description = [property.title, property.description].filter((v) => v).join(' - ');
  	let choices: string[] = [];
  	if (property.enum) {
  	choices.push(...(property.enum.filter((v) => typeof v === 'string') as string[]));
  	}
  	if (typeof property.items === 'object' && 'enum' in property.items && property.items.enum) {
  	choices.push(...(property.items.enum.filter((v) => typeof v === 'string') as string[]));
  	}
  	if (choices.length > 0) {
  	description += ` (choices: "${choices.join('", "')})`;
  	}
  	if (property.default !== undefined && property.default !== null) {
  	option.default(typeof property.default === 'boolean' ? property.default : property.default.toString());
  	}
  	option.description = description;
  	result.push(option);
  	}
  	}
  	return result;
  	}

And also in the documentation:

• https://avatars.dicebear.com/styles/adventurer#style-options
• https://github.com/dicebear/dicebear/blob/88c396fdffadf8d12f2017aeab10e33c570305f1/website/src/components/docs/style/options.tsx