Avatar Maker

Generate random avatar images (in SVG format).

Installation

# Using yarn
yarn add @tdrmk/avatarmaker

# Using npm
npm install @tdrmk/avatarmaker

CDN Links

<script src="https://unpkg.com/@tdrmk/avatarmaker/dist/index.js" defer></script>
<script>
  window.addEventListener("DOMContentLoaded", () => {
    const { svg } = window.AvatarMaker.generateAvatar();
    document.querySelector("#avatar").innerHTML = svg;
  });
</script>

Usage

Generate a random image (gender chosen at random).

const { generateAvatar } = require("@tdrmk/avatarmaker");

// generate a random avatar
const { svg } = generateAvatar();

// logs the svg image
console.log(svg);

Generate a random image with specified gender (male or female).

const { generateAvatar } = require("@tdrmk/avatarmaker");

// generate a random male avatar
const { svg } = generateAvatar({ gender: "male" });

// logs the svg image
console.log(svg);

Obtain features from generated image

const { generateAvatar } = require("@tdrmk/avatarmaker");

// generate a random avatar
const { svg, chosen_zones } = generateAvatar();

// logs the chosen features
console.log(chosen_zones);

// logs the svg image
console.log(svg);

Generate an image with specified features

const { generateAvatar } = require("@tdrmk/avatarmaker");

const chosen_zones = {
  backs: 7,
  clothes: 1,
  ears: 3,
  faceshape: 9,
  mouth: 14,
  eyesiris: 5,
  eyesfront: 8,
  eyebrows: 3,
  nose: 1,
};

// generate a random avatar
const { svg } = generateAvatar({ gender: "male", chosen_zones });

// logs the svg image
console.log(svg);

All available features

const chosen_zones = {
  backs: 1,
  hairback: 13,
  humanbody: 0,
  chinshadow: 5,
  clothes: 11,
  ears: 6,
  faceshape: 11,
  mouth: 13,
  eyesback: 2,
  eyesiris: 7,
  eyesfront: 0,
  facehighlight: 0,
  eyebrows: 10,
  nose: 2,
  beard: 8,
  mustache: 11,
  hairfront: 13,
  glasses: 2,
};

Using Avatar ID

const { generateAvatar } = require("@tdrmk/avatarmaker");
// generate a random avatar
const { avatarId, svg } = generateAvatar({ gender: "male" });
// Ex: avatarId = '1012136229674839'

// some other code ...

// later on regenerate same avatar, use the unique avatar id
const { svg } = generateAvatar({ avatarId });