====== TheDraw Figlets ======

Synchronet JS conversion of ''tdfiglet.c'' based on the C code by Unknown/Modified by The Draw and converted to Synchronet JS by [[person:Nelgin]].

A [[wp>FIGlet]] is a readable word constructed from fonts of character art, for example:
<file>
888          888   .d888  d8b            888            888
888          888  d88P"   Y8P            888            888
888          888  888                    888            888
888888   .d88888  888888  888   .d88b.   888   .d88b.   888888
888     d88" 888  888     888  d88P"88b  888  d8P  Y8b  888
888     888  888  888     888  888  888  888  88888888  888
Y88b.   Y88b 888  888     888  Y88b 888  888  Y8b.      Y88b.
 "Y888   "Y88888  888     888   "Y88888  888   "Y88888   "Y888
                                    888
                               Y8b d88P
                                "Y88P"
</file>

This module (and its underlying library, ''[[dir:load]]/tdfonts_lib.js'') may be used to construct words from more than one thousand available TheDraw fonts (stored in ''[[dir:ctrl]]/tdfonts'').

===== Invoke =====

This module can be invoked via [[util:JSexec]] or directly from within Synchronet.

<file>
usage: tdfiglet [options] input

    -f [font] Specify font file to use
    -j l|r|c  Justify left, right, or center (default: left)
    -w n      Set screen width  (default: auto-detect or 80)
    -m n      Set margin/offset (for left or right justification)
    -a        Enable ANSI sequences (default: Synchronet Ctrl-A)
    -u        Encode characters as UTF-8 (default: CP437)
    -x n      Index to font within file (default: 0)
    -n        No blank line between wrapped output lines
    -W        Always word-wrap the output
    -i        Print font details
    -l        Loop through the available fonts
    -p        Pause between fonts
    -r        Use random font and/or index (if not specified with -x)
    -R        Use random font and auto-retry upon exception
    -h        Print usage
</file>

===== See Also =====
  * [[:module:|module index]]

{{tag>ansi thedraw fonts}}
