# Asciifyer

Asciifyer is an npm package that allows you to convert regular text into stylized ASCII art using various fonts. It supports multiple font styles and is easy to integrate into your Node.js projects.

## Features

- Convert text to ASCII art
- Multiple font styles (including Standard, Whimsy, and more)
- You just download the fonts you use!

## Installation

```bash
npm install asciifyer
```

## Usage Example
Remember that only the fonts that you use will be installed!
```javascript
const { stringToAscii, fonts } = require('asciifyer');

// Generate ASCII art with the "Univers" font
const asciiArt = await stringToAscii('Hello, World!', fonts.Univers);
console.log(asciiArt);
```
If you wanna delete all the fonts you have on your project you can just use. This will clear the Fonts folder from the npm.
```javascript
const { clearFonts } = require('asciifyer');

clearFonts().then(() => {
    console.log('Fonts cleared!');
})
```

## Fonts
For selecting the font use fonts.And the id of the font. The fonts will be downloaded when you want to use it making this library pretty lightweight.

- Doom ID: Doom
```bash
______
|  _  \
| | | |  ___    ___   _ __ ___  
| | | | / _ \  / _ \ | '_ ` _ \ 
| |/ / | (_) || (_) || | | | | |
|___/   \___/  \___/ |_| |_| |_|

```
- Slant ID: Slant
```bash
   _____    __                   __ 
  / ___/   / /  ____ _   ____   / /_
  \__ \   / /  / __ `/  / __ \ / __/
 ___/ /  / /  / /_/ /  / / / // /_
/____/  /_/   \__,_/  /_/ /_/ \__/
```
- Star Wars ID: StarWars
```bash
     _______..___________.     ___      .______         ____    __    ____      ___      .______           _______.
    /       ||           |    /   \     |   _  \        \   \  /  \  /   /     /   \     |   _  \         /       |
   |   (----``---|  |----`   /  ^  \    |  |_)  |        \   \/    \/   /     /  ^  \    |  |_)  |       |   (----`
    \   \        |  |       /  /_\  \   |      /          \            /     /  /_\  \   |      /         \   \
.----)   |       |  |      /  _____  \  |  |\  \----.      \    /\    /     /  _____  \  |  |\  \----..----)   |
|_______/        |__|     /__/     \__\ | _| `._____|       \__/  \__/     /__/     \__\ | _| `._____||_______/
```
- ANSI Regular ID: ANSIRegular
```bash
 █████  ███    ██ ███████ ██     ██████  ███████  ██████  ██    ██ ██       █████  ██████  
██   ██ ████   ██ ██      ██     ██   ██ ██      ██       ██    ██ ██      ██   ██ ██   ██ 
███████ ██ ██  ██ ███████ ██     ██████  █████   ██   ███ ██    ██ ██      ███████ ██████  
██   ██ ██  ██ ██      ██ ██     ██   ██ ██      ██    ██ ██    ██ ██      ██   ██ ██   ██ 
██   ██ ██   ████ ███████ ██     ██   ██ ███████  ██████   ██████  ███████ ██   ██ ██   ██ 
```
- ANSI Shadow ID: ANSIShadow
```bash
 █████╗ ███╗   ██╗███████╗██╗    ███████╗██╗  ██╗ █████╗ ██████╗  ██████╗ ██╗    ██╗
██╔══██╗████╗  ██║██╔════╝██║    ██╔════╝██║  ██║██╔══██╗██╔══██╗██╔═══██╗██║    ██║
███████║██╔██╗ ██║███████╗██║    ███████╗███████║███████║██║  ██║██║   ██║██║ █╗ ██║
██╔══██║██║╚██╗██║╚════██║██║    ╚════██║██╔══██║██╔══██║██║  ██║██║   ██║██║███╗██║
██║  ██║██║ ╚████║███████║██║    ███████║██║  ██║██║  ██║██████╔╝╚██████╔╝╚███╔███╔╝
╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝╚═╝    ╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝  ╚═════╝  ╚══╝╚══╝ 
```
- 3D-ASCII ID: IIIDASCII
```bash
 ________      ________                     ________      ________       ________      ___      ___     
|\_____  \    |\   ___ \                   |\   __  \    |\   ____\     |\   ____\    |\  \    |\  \
\|____|\ /_   \ \  \_|\ \    ____________  \ \  \|\  \   \ \  \___|_    \ \  \___|    \ \  \   \ \  \
      \|\  \   \ \  \ \\ \  |\____________\ \ \   __  \   \ \_____  \    \ \  \        \ \  \   \ \  \
     __\_\  \   \ \  \_\\ \ \|____________|  \ \  \ \  \   \|____|\  \    \ \  \____    \ \  \   \ \  \
    |\_______\   \ \_______\                  \ \__\ \__\    ____\_\  \    \ \_______\   \ \__\   \ \__\
    \|_______|    \|_______|                   \|__|\|__|   |\_________\    \|_______|    \|__|    \|__|
                                                            \|_________|
```
- Delta Corps Priest 1 ID: DeltaCorpsPriest
```bash
████████▄     ▄████████  ▄█           ███        ▄████████       ▄████████  ▄██████▄     ▄████████    ▄███████▄    ▄████████         ▄███████▄    ▄████████  ▄█     ▄████████    ▄████████     ███
███   ▀███   ███    ███ ███       ▀█████████▄   ███    ███      ███    ███ ███    ███   ███    ███   ███    ███   ███    ███        ███    ███   ███    ███ ███    ███    ███   ███    ███ ▀█████████▄       
███    ███   ███    █▀  ███          ▀███▀▀██   ███    ███      ███    █▀  ███    ███   ███    ███   ███    ███   ███    █▀         ███    ███   ███    ███ ███▌   ███    █▀    ███    █▀     ▀███▀▀██       
███    ███  ▄███▄▄▄     ███           ███   ▀   ███    ███      ███        ███    ███  ▄███▄▄▄▄██▀   ███    ███   ███               ███    ███  ▄███▄▄▄▄██▀ ███▌  ▄███▄▄▄       ███            ███   ▀       
███    ███ ▀▀███▀▀▀     ███           ███     ▀███████████      ███        ███    ███ ▀▀███▀▀▀▀▀   ▀█████████▀  ▀███████████      ▀█████████▀  ▀▀███▀▀▀▀▀   ███▌ ▀▀███▀▀▀     ▀███████████     ███
███    ███   ███    █▄  ███           ███       ███    ███      ███    █▄  ███    ███ ▀███████████   ███                 ███        ███        ▀███████████ ███    ███    █▄           ███     ███
███   ▄███   ███    ███ ███▌    ▄     ███       ███    ███      ███    ███ ███    ███   ███    ███   ███           ▄█    ███        ███          ███    ███ ███    ███    ███    ▄█    ███     ███
████████▀    ██████████ █████▄▄██    ▄████▀     ███    █▀       ████████▀   ▀██████▀    ███    ███  ▄████▀       ▄████████▀        ▄████▀        ███    ███ █▀     ██████████  ▄████████▀     ▄████▀
                        ▀                                                               ███    ███                                               ███    ███
```
- DOS Rebel ID: DOSRebel
```bash
 ██████████      ███████     █████████     ███████████            █████              ████ 
░░███░░░░███   ███░░░░░███  ███░░░░░███   ░░███░░░░░███          ░░███              ░░███
 ░███   ░░███ ███     ░░███░███    ░░░     ░███    ░███   ██████  ░███████   ██████  ░███
 ░███    ░███░███      ░███░░█████████     ░██████████   ███░░███ ░███░░███ ███░░███ ░███
 ░███    ░███░███      ░███ ░░░░░░░░███    ░███░░░░░███ ░███████  ░███ ░███░███████  ░███
 ░███    ███ ░░███     ███  ███    ░███    ░███    ░███ ░███░░░   ░███ ░███░███░░░   ░███
 ██████████   ░░░███████░  ░░█████████     █████   █████░░██████  ████████ ░░██████  █████
░░░░░░░░░░      ░░░░░░░     ░░░░░░░░░     ░░░░░   ░░░░░  ░░░░░░  ░░░░░░░░   ░░░░░░  ░░░░░
```
- Georgia11 ID: Georgia11
```bash
                                                     ,,
  .g8"""bgd                                          db
.dP'     `M                                                        __,   __,
dM'       `   .gP"Ya   ,pW"Wq.  `7Mb,od8  .P"Ybmmm `7MM   ,6"Yb.  `7MM  `7MM
MM           ,M'   Yb 6W'   `Wb   MM' "' :MI  I8     MM  8)   MM    MM    MM
MM.    `7MMF'8M"""""" 8M     M8   MM      WmmmP"     MM   ,pm9MM    MM    MM
`Mb.     MM  YM.    , YA.   ,A9   MM     8M          MM  8M   MM    MM    MM
  `"bmmmdPY   `Mbmmd'  `Ybmd9'  .JMML.    YMMMMMb  .JMML.`Moo9^Yo..JMML..JMML.
                                         6'     dP
                                         Ybmmmd'
```
- Univers ID: Univers
```bash
88        88               88
88        88               ""
88        88
88        88  8b,dPPYba,   88  8b       d8   ,adPPYba,  8b,dPPYba,  ,adPPYba,
88        88  88P'   `"8a  88  `8b     d8'  a8P_____88  88P'   "Y8  I8[    ""
88        88  88       88  88   `8b   d8'   8PP"""""""  88           `"Y8ba,
Y8a.    .a8P  88       88  88    `8b,d8'    "8b,   ,aa  88          aa    ]8I
 `"Y8888Y"'   88       88  88      "8"       `"Ybbd8"'  88          `"YbbdP"'
```
- stencil ID: stencil
```bash
   .=#@@-.%@#=#%  -@@@% *@@@@@@* @@@@- *@@@@@@@.=@@@@@+  *@@@@@@@@*   -@@@@@*     .=#%@-:%%*=%#  +@@@@@@@@=  *@@@@@@@@-      
  =@@@#.   -#@@@  -@@#. *@@@@@@* .#@@-  +@@@@@@: .:*@@+   .#@@@@@@@*    *@%:     +@@@@:  .=@@@%   -@@@@@@-    +@@@@@@:
 =@@@@*      +@@  -@@   *@@@@@@*  .@@-  =@@@@@@:    =@+     +@@@@@@@#   .@+     #@@@@*     .%@%   :@@@@@@:    =@@@@@@.
 %@@@@@%+-.   ##  :%+   *@@@@@@*   +%:  =@@@@@@:  =# -.    +:=@@@@@@@%. .@+    *@@@@@#      :@%   -@@@@@@:    =@@@@@@.
 *@@@@@@@@@%*-          *@@@@@@*        =@@@@@@: -@@       *@ =@@@@@@@%. @+   .@@@@@@#       --   -@@@@@@:    =@@@@@@.
 .#@@@@@@@@@@@%-        *@@@@@@*        =@@@@@@.=@@%       *@. -@@@@@@@@:=+   =@@@@@@#            -@@@@@@:    =@@@@@@.
   -#@@@@@@@@@@@-       *@@@@@@*        =@@@@@@: -@@       *@   :@@@@@@@@-    -@@@@@@#            -@@@@@@:    =@@@@@@.
 +*  .-+#@@@@@@@#       *@@@@@@*        =@@@@@@:  =# ..    *@    .%@@@@@@@-   .@@@@@@#            -@@@@@@:    =@@@@@@.    =*
 %@+      -%@@@@+       *@@@@@@*        =@@@@@@:    .@#    *@     .#@@@@@@+    +@@@@@*       ##   -@@@@@@:    =@@@@@@.   .@@
 #@@+      *@@@#        *@@@@@@*        =@@@@@@:   =@@*    %@-      #@@@@@+     *@@@@#     .#@-   :@@@@@@:    =@@@@@@.  :%@@
 %@@@@*: +%@@#-       .*@@@@@@@@*.     +@@@@@@@.-#@@@@#  +@@@@*.     *@@@@+      :*@@@#..+#@#.   =%@@@@@@%-  +@@@@@@@.=%@@@@
 :- .-+- +=:.          -:::::::::      :::::::: .-::::.  ::::::       ::::.         :-+:.+-.     .::::::::.  :::::::: :-::::
```
More fonts will be added in the future

## Disclaimer

This project was made with help of GitHub Copilot.
Also feel free to modify it as you want!
## License

MIT