mystic-symbol-generator v1.2.3

Mystic Symbol Generator

The mystic-symbol-generator is a JavaScript library for generating mystic symbols using the p5.js library for drawing, seedrandom for predictable randomness, and SVG.js for SVG support. It's designed to be easily embedded in web pages and allows for customizable symbol generation.

Features

• Generate unique mystic symbols based on a seed value.
• Customize symbol size.
• Export symbols as SVG images.

Installation

To install the library, you can use npm:

npm install mystic-symbol-generator

Usage

First, make sure to import the library into your project:

import MysticSymbolGenerator from 'mystic-symbol-generator';

Basic Example

To generate a mystic symbol, you need to create an instance of MysticSymbolGenerator with a container ID where the symbol will be rendered and optionally pass in options for seed and size.

<div id="symbolContainer"></div>

const options = {
seed: 'yourSeedHere', // Optional: define a seed for symbol generation
size: 200 // Optional: define the size of the symbol
};

const symbolGenerator = new MysticSymbolGenerator('symbolContainer', options);

Exporting Symbols as SVG

You can also export the generated symbol as an SVG image:

symbolGenerator.exportSVG();

This will add the SVG to the container specified during the creation of the MysticSymbolGenerator instance.

API Reference

Constructor

new MysticSymbolGenerator(containerId, options)

• containerId: The ID of the container element where the symbol will be rendered.
• options: An object with optional settings:
  • seed: A string value to seed the randomness for symbol generation.
  • size: The size (width and height) of the symbol.

Methods

• exportSVG(): Exports the currently displayed symbol as an SVG image.

Contributing

Contributions are welcome! Please feel free to submit pull requests or create issues for bugs and feature requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.