Module figlet
Figlet A module to read figlet fonts and produce figlet ascii art from text
Info:
- Copyright: 2010,2011 Nick Gammon,2022 Damian Monogue
Functions
| Figlet.readfont(filename) | Reads a figlet font file (.flf) into memory and readies it for use by the next figlet These files are cached in memory so that future calls to load a font just read from there. |
| Figlet.ascii_art(s, kern, smush) | Returns a table of lines representing a string as figlet |
| Figlet.getString(str, kern, smush) | Returns the figlet as a string, rather than a table |
| Figlet.getKern(str) | Returns a figlet as a string, with kern set to true. |
| Figlet.getSmush(str) | Returns a figlet as a string, with smush set to true. |
Functions
- Figlet.readfont(filename) line 79
-
Reads a figlet font file (.flf) into memory and readies it for use by the next figlet
These files are cached in memory so that future calls to load a font just read from there.
Parameters:
- filename the full path to the file to read the font from
- Figlet.ascii_art(s, kern, smush) line 214
-
Returns a table of lines representing a string as figlet
Parameters:
- s string the text to make into a figlet
- kern boolean should we reduce spacing
- smush boolean causes the letters to share edges, condensing it even further
- Figlet.getString(str, kern, smush) line 248
-
Returns the figlet as a string, rather than a table
Parameters:
- str string the string the make into a figlet
- kern boolean should we reduce the space between letters?
- smush boolean should the letters share edges, further condensing the output?
See also:
- Figlet.getKern(str) line 256
-
Returns a figlet as a string, with kern set to true.
Parameters:
- str string The string to turn into a figlet
See also:
- Figlet.getSmush(str) line 263
-
Returns a figlet as a string, with smush set to true.
Parameters:
- str string The string to turn into a figlet
See also: