generateSpiritTree

Callable

• generateSpiritTree(tree: any, options?: GenerateSpiritTreeOptions): Promise<Buffer>

---

• Generates a spirit tree image as a Buffer.

  @example

  import { generateSpiritTree } from './SpiritTreeRenderer';
  import type { ISpiritTree } from '@skyhelperbot/constants/skygame-planner';
  
  const tree: ISpiritTree = getSpiritTreeData();
  const buffer = await generateSpiritTree(tree, {
    season: true,
    spiritName: "Grateful Spirit",
    spiritSubtitle: "Season of Gratitude",
    highlightItems: ["item1", "item2"],
    scale: 1
  });

  ---

  Parameters

  Name	Type	Default	Description
  tree	any		The spirit tree data to render.
  options	GenerateSpiritTreeOptions	= {}	rendering options.

  Returns Promise<Buffer>

  A promise that resolves to a PNG image buffer of the rendered spirit tree.