Avatune
Themes

@avatune/orks-theme

Avatar theme for Avatune using Orks assets.

Source: packages/assets/orks-assets/README.md

Avatar theme for Avatune using orks design assets.

Installation

npm install @avatune/orks-theme

Usage

This theme is available for multiple frameworks: React, Vue, Svelte, Angular, and Vanilla JavaScript.

React

import { Avatar } from '@avatune/react'
import theme from '@avatune/orks-theme/react'

function App() {
  return (
    <Avatar
      theme={theme}
      size={300}
      seed="optional-seed-for-random-generation"
    />
  )
}

Vue

<script setup lang="ts">
import { Avatar } from '@avatune/vue'
import theme from '@avatune/orks-theme/vue'
</script>

<template>
  <Avatar
    :theme="theme"
    :size="300"
    seed="optional-seed-for-random-generation"
  />
</template>

Svelte

<script lang="ts">
  import { Avatar } from '@avatune/svelte'
  import theme from '@avatune/orks-theme/svelte'
</script>

<Avatar
  theme={theme}
  size={300}
  seed="optional-seed-for-random-generation"
/>

Angular

import { Component } from '@angular/core'
import { Avatar } from '@avatune/angular'
import theme from '@avatune/orks-theme/angular'

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [Avatar],
  template: `
    <avatune-avatar
      [theme]="theme"
      [inputSize]="300"
      seed="optional-seed-for-random-generation"
    />
  `,
})
export class AppComponent {
  theme = theme
}

Vanilla JavaScript

import { avatar } from '@avatune/vanilla'
import theme from '@avatune/orks-theme/vanilla'

const container = document.getElementById('avatar-container')
const svg = avatar({
  theme,
  size: 300,
  seed: 'optional-seed-for-random-generation',
})

container?.appendChild(svg)

Customization

You can override specific avatar parts:

<Avatar
  theme={theme}
  size={300}
  hair="braid"          // Choose specific hair style
  hairColor="#FF5733"    // Custom hair color
  body="armor"     // Choose specific clothing
  bodyColor="#3498DB"    // Custom clothing color
/>

Design Assets

This theme uses Orks style SVG assets for creating customizable avatars. Assets include various options for hair, eyes, eyebrows, mouth, nose, ears, head shape, and body/clothing.

The assets are available in the @avatune/orks-assets package.

Using Assets Directly

SVG Paths

import { hair, eyes, mouth } from '@avatune/orks-assets';

React Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/orks-assets/react';

Svelte Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/orks-assets/svelte';

Vue Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/orks-assets/vue';

Available Assets

Body

PreviewFilename
armor
furJacket
hoodie
openJacket
studdedVest
tunic
wrapTunic

Eyebrows

PreviewFilename
angry
calm
confident
default
neutral

Eyes

PreviewFilename
default
scared
tired

Hair

PreviewFilename
braid
braids
bun
dreadlocks
long
mohawk
short
sideForelock
PreviewFilename
default
large
sqaure

Mouth

PreviewFilename
dracula
hooky
neutral
open
openTusks
smile

Nose

PreviewFilename
default

License & Credits

Theme License

This theme package is licensed under a modified MIT license that permits any use except repackaging its avatar assets into other avatar libraries such as DiceBear (see LICENSE.md).

Design Assets License

The design assets used in this theme are separately licensed. See the asset package for details.

Development

# Build the theme
bun run build

# Build in watch mode
bun run dev

# Type checking
bun run check-types

On this page