ascii

Documentation

Index

• Variables
• func GetFonts() []string
• func MatchFont(name string) string
• func ParseFlf(fontName string, gz string) (*font, error)
• func Print(args Args)
• func Random(args Args)
• type Args
• type ColourMode
  • func GetColourMode(p string) ColourMode
• type Palette
  • func GetPalette(p string) Palette
  • func (c *Palette) IsEmpty() bool

Variables

var (
	PaletteMintGreen = Palette{
		Name:       "Mint Green",
		Key:        "mint",
		Colours:    []string{"CCFFBD", "7ECA9C", "4b795d"},
		ColourMode: modeVerticalGradient,
	}
	PaletteRetroIcyPole = Palette{
		Name:       "Retro Icy Pole",
		Key:        "retro",
		Colours:    []string{"F38181", "FCE38A", "EAFFD0", "95E1D3"},
		ColourMode: modeVerticalGradient,
	}
	PaletteDesert = Palette{
		Name:       "Dessert",
		Key:        "desert",
		Colours:    []string{"FFACAC", "FFBFA9", "FFEBB4", "FBFFB1"},
		ColourMode: modeVerticalGradient,
	}
	PaletteIceBlue = Palette{
		Name:       "Ice Blue",
		Key:        "ice",
		Colours:    []string{"E3FDFD", "CBF1F5", "A6E3E9", "71C9CE"},
		ColourMode: modeVerticalGradient,
	}
	PaletteSwampGreen = Palette{
		Name:       "Swamp Green",
		Key:        "swamp",
		Colours:    []string{"DDFFBB", "C7E9B0", "B3C99C"},
		ColourMode: modeVerticalGradient,
	}
	PaletteBogGreen = Palette{
		Name:       "BOG™",
		Key:        "bog",
		Colours:    []string{"7DCE13", "70b911", "64a40f"},
		ColourMode: modeVerticalGradient,
	}
	PaletteMatrixGreen = Palette{
		Name:       "Matrix",
		Key:        "matrix",
		Colours:    []string{"00FF41", "00cc34", "009927"},
		ColourMode: modeVerticalGradient,
	}
	PaletteGoogle = Palette{
		Name:       "Google Theme",
		Key:        "google",
		Colours:    []string{"4285F4", "DB4437", "F4B400", "4285F4", "0F9D58", "DB4437"},
		ColourMode: modeLetter,
	}
	White = Palette{
		Name:       "White",
		Key:        "white",
		Colours:    []string{"FFFFFF"},
		ColourMode: modeSingle,
	}
	PaletteRed = Palette{
		Name:       "Red",
		Key:        "red",
		Colours:    []string{"ff0000"},
		ColourMode: modeSingle,
	}
	PaletteGreen = Palette{
		Name:       "Green",
		Key:        "green",
		Colours:    []string{"008000"},
		ColourMode: modeSingle,
	}
	PaletteBlue = Palette{
		Name:       "Blue",
		Key:        "blue",
		Colours:    []string{"0000ff"},
		ColourMode: modeSingle,
	}
	PaletteYellow = Palette{
		Name:       "Yellow",
		Key:        "yellow",
		Colours:    []string{"ffff00"},
		ColourMode: modeSingle,
	}
	PalettePurple = Palette{
		Name:       "Purple",
		Key:        "purple",
		Colours:    []string{"A020F0"},
		ColourMode: modeSingle,
	}
	PaletteRedBlack = Palette{
		Name:       "Red-Black",
		Key:        "red-black",
		Colours:    []string{"ff0000", "36454F"},
		ColourMode: modeAlternate,
	}
	PaletteRedOrange = Palette{
		Name:       "Red Orange",
		Key:        "red-orange",
		Colours:    []string{"ff0000", "FF5733"},
		ColourMode: modeAlternate,
	}
	PalettePizza = Palette{
		Name:       "Pizza Mode",
		Key:        "pizza",
		Colours:    []string{"008c45", "f4f5f0", "cd212a"},
		ColourMode: modeHorizontalGradient,
	}
	PalettePatriot = Palette{
		Name:       "Patriot Mode",
		Key:        "patriot",
		Colours:    []string{"ff0000", "FFFFFF", "003472"},
		ColourMode: modePatriot,
	}
)

https://colorhunt.co/palettes/neon

var DefaultArgs = Args{
	Message: "ascii banner",
	Font:    FontANSIShadow,
	Palette: PaletteDefault,
}

var FontAMC3Line = "amc3line"

var FontAMC3Liv1 = "amc3liv1"

var FontAMCAAA01 = "amcaaa01"

var FontAMCNeko = "amcneko"

var FontAMCRazor = "amcrazor"

var FontAMCRazor2 = "amcrazor2"

var FontAMCSlash = "amcslash"

var FontAMCSlider = "amcslider"

var FontAMCThin = "amcthin"

var FontAMCTubes = "amctubes"

var FontAMCUntitled = "amcuntitled"

var FontANSIRegular = "ansiregular"

var FontANSIShadow = "ansishadow"

var FontASCIINewRoman = "asciinewroman"

var FontAcrobatic = "acrobatic"

var FontAlligator = "alligator"

var FontAlligator2 = "alligator2"

var FontAlligator3 = "alligator3"

var FontAlpha = "alpha"

var FontAlphabet = "alphabet"

var FontAmcrazo2 = "amcrazo2"

var FontAmcslder = "amcslder"

var FontAmcun1 = "amcun1"

var FontArrows = "arrows"

var FontAvatar = "avatar"

var FontB1FF = "b1ff"

var FontBanner = "banner"

var FontBanner3 = "banner3"

var FontBanner3D = "banner3d"

var FontBanner4 = "banner4"

var FontBarbwire = "barbwire"

var FontBasic = "basic"

var FontBear = "bear"

var FontBell = "bell"

var FontBenjamin = "benjamin"

var FontBig = "big"

var FontBigChief = "bigchief"

var FontBigMoneyne = "bigmoneyne"

var FontBigMoneynw = "bigmoneynw"

var FontBigMoneyse = "bigmoneyse"

var FontBigMoneysw = "bigmoneysw"

var FontBigfig = "bigfig"

var FontBinary = "binary"

var FontBlock = "block"

var FontBlocks = "blocks"

var FontBloody = "bloody"

var FontBolger = "bolger"

var FontBraced = "braced"

var FontBright = "bright"

var FontBroadway = "broadway"

var FontBroadwayKB = "broadwaykb"

var FontBubble = "bubble"

var FontBulbhead = "bulbhead"

var FontCalgphy2 = "calgphy2"

var FontCaligraphy = "caligraphy"

var FontCaligraphy2 = "caligraphy2"

var FontCalvinS = "calvins"

var FontCatwalk = "catwalk"

var FontChiseled = "chiseled"

var FontChunky = "chunky"

var FontCoinstak = "coinstak"

var FontCola = "cola"

var FontColossal = "colossal"

var FontComputer = "computer"

var FontContessa = "contessa"

var FontContrast = "contrast"

var FontCosmic = "cosmic"

var FontCosmike = "cosmike"

var FontCrawford = "crawford"

var FontCrawford2 = "crawford2"

var FontCrazy = "crazy"

var FontCricket = "cricket"

var FontCursive = "cursive"

var FontCyberlarge = "cyberlarge"

var FontCybermedium = "cybermedium"

var FontCybersmall = "cybersmall"

var FontCygnet = "cygnet"

var FontDANC4 = "danc4"

var FontDOSRebel = "dosrebel"

var FontDWhistled = "dwhistled"

var FontDancingFont = "dancingfont"

var FontDecimal = "decimal"

var FontDefLeppard = "defleppard"

var FontDefault = FontANSIShadow

var FontDeltaCorpsPriest1 = "deltacorpspriest1"

var FontDiamond = "diamond"

var FontDietCola = "dietcola"

var FontDigital = "digital"

var FontDoh = "doh"

var FontDoom = "doom"

var FontDotMatrix = "dotmatrix"

var FontDouble = "double"

var FontDoubleShorts = "doubleshorts"

var FontDrPepper = "drpepper"

var FontEftiChess = "eftichess"

var FontEftiFont = "eftifont"

var FontEftiItalic = "eftiitalic"

var FontEftiPiti = "eftipiti"

var FontEftiRobot = "eftirobot"

var FontEftiWall = "eftiwall"

var FontEftiWater = "eftiwater"

var FontEftitalic = "eftitalic"

var FontElectronic = "electronic"

var FontElite = "elite"

var FontEpic = "epic"

var FontF1Row = "f1row"

var FontF3D = "f3d"

var FontF3DASCII = "f3dascii"

var FontF3DDiagonal = "f3ddiagonal"

var FontF3x5 = "f3x5"

var FontF4Max = "f4max"

var FontF5LineOblique = "f5lineoblique"

var FontFender = "fender"

var FontFilter = "filter"

var FontFireFontk = "firefontk"

var FontFireFonts = "firefonts"

var FontFlipped = "flipped"

var FontFlowerPower = "flowerpower"

var FontFourTops = "fourtops"

var FontFunFace = "funface"

var FontFunFaces = "funfaces"

var FontFuzzy = "fuzzy"

var FontGeorgi16 = "georgi16"

var FontGeorgia11 = "georgia11"

var FontGhost = "ghost"

var FontGhoulish = "ghoulish"

var FontGlenyn = "glenyn"

var FontGoofy = "goofy"

var FontGothic = "gothic"

var FontGraceful = "graceful"

var FontGradient = "gradient"

var FontGraffiti = "graffiti"

var FontGreek = "greek"

var FontHalfiwi = "halfiwi"

var FontHenry3D = "henry3d"

var FontHex = "hex"

var FontHieroglyphs = "hieroglyphs"

var FontHollywood = "hollywood"

var FontHorizontalLeft = "horizontalleft"

var FontHorizontalRight = "horizontalright"

var FontICL1900 = "icl1900"

var FontImpossible = "impossible"

var FontInvita = "invita"

var FontIsometric1 = "isometric1"

var FontIsometric2 = "isometric2"

var FontIsometric3 = "isometric3"

var FontIsometric4 = "isometric4"

var FontItalic = "italic"

var FontIvrit = "ivrit"

var FontJSBlockLetters = "jsblockletters"

var FontJSBracketLetters = "jsbracketletters"

var FontJSCapitalCurves = "jscapitalcurves"

var FontJSCursive = "jscursive"

var FontJSStickLetters = "jsstickletters"

var FontJacky = "jacky"

var FontJazmine = "jazmine"

var FontJerusalem = "jerusalem"

var FontKatakana = "katakana"

var FontKban = "kban"

var FontKeyboard = "keyboard"

var FontKnob = "knob"

var FontKonto = "konto"

var FontKontoSlant = "kontoslant"

var FontLCD = "lcd"

var FontLarry3D = "larry3d"

var FontLarry3D2 = "larry3d2"

var FontLean = "lean"

var FontLetters = "letters"

var FontLilDevil = "lildevil"

var FontLineBlocks = "lineblocks"

var FontLinux = "linux"

var FontLockergnome = "lockergnome"

var FontMadrid = "madrid"

var FontMarquee = "marquee"

var FontMaxfour = "maxfour"

var FontMerlin1 = "merlin1"

var FontMerlin2 = "merlin2"

var FontMike = "mike"

var FontMini = "mini"

var FontMirror = "mirror"

var FontMnemonic = "mnemonic"

var FontModular = "modular"

var FontMorse = "morse"

var FontMorse2 = "morse2"

var FontMoscow = "moscow"

var FontMshebrew210 = "mshebrew210"

var FontMuzzle = "muzzle"

var FontNScript = "nscript"

var FontNTGreek = "ntgreek"

var FontNVScript = "nvscript"

var FontNancyj = "nancyj"

var FontNancyjFancy = "nancyjfancy"

var FontNancyjImproved = "nancyjimproved"

var FontNancyjUnderlined = "nancyjunderlined"

var FontNipples = "nipples"

var FontO8 = "o8"

var FontOS2 = "os2"

var FontOctal = "octal"

var FontOgre = "ogre"

var FontOldBanner = "oldbanner"

var FontPatorjkHeX = "patorjkhex"

var FontPatorjksCheese = "patorjkscheese"

var FontPawp = "pawp"

var FontPeaks = "peaks"

var FontPeaksSlant = "peaksslant"

var FontPebbles = "pebbles"

var FontPepper = "pepper"

var FontPoison = "poison"

var FontPuffy = "puffy"

var FontPuzzle = "puzzle"

var FontPyramid = "pyramid"

var FontRammstein = "rammstein"

var FontRectangles = "rectangles"

var FontRedPhoenix = "redphoenix"

var FontRelief = "relief"

var FontRelief2 = "relief2"

var FontRev = "rev"

var FontReverse = "reverse"

var FontRoman = "roman"

var FontRot13 = "rot13"

var FontRotated = "rotated"

var FontRounded = "rounded"

var FontRowanCap = "rowancap"

var FontRozzo = "rozzo"

var FontRunic = "runic"

var FontRunyc = "runyc"

var FontSBlood = "sblood"

var FontSLScript = "slscript"

var FontSantaClara = "santaclara"

var FontScript = "script"

var FontSerifcap = "serifcap"

var FontShadow = "shadow"

var FontShimrod = "shimrod"

var FontShort = "short"

var FontSlant = "slant"

var FontSlantRelief = "slantrelief"

var FontSlide = "slide"

var FontSmall = "small"

var FontSmallCaps = "smallcaps"

var FontSmallIsometric1 = "smallisometric1"

var FontSmallKeyboard = "smallkeyboard"

var FontSmallPoison = "smallpoison"

var FontSmallScript = "smallscript"

var FontSmallShadow = "smallshadow"

var FontSmallSlant = "smallslant"

var FontSmallTengwar = "smalltengwar"

var FontSmisome1 = "smisome1"

var FontSmkeyboard = "smkeyboard"

var FontSmpoison = "smpoison"

var FontSmscript = "smscript"

var FontSmshadow = "smshadow"

var FontSmslant = "smslant"

var FontSmtengwar = "smtengwar"

var FontSoft = "soft"

var FontSpeed = "speed"

var FontSpliff = "spliff"

var FontSrelief = "srelief"

var FontStacey = "stacey"

var FontStampate = "stampate"

var FontStampatello = "stampatello"

var FontStandard = "standard"

var FontStarStrips = "starstrips"

var FontStarWars = "starwars"

var FontStellar = "stellar"

var FontStforek = "stforek"

var FontStickLetters = "stickletters"

var FontStop = "stop"

var FontStraight = "straight"

var FontStrongerThanAll = "strongerthanall"

var FontSubZero = "subzero"

var FontSwampLand = "swampland"

var FontSwan = "swan"

var FontSweet = "sweet"

var FontTHIS = "this"

var FontTanja = "tanja"

var FontTengwar = "tengwar"

var FontTerm = "term"

var FontTest1 = "test1"

var FontTheEdge = "theedge"

var FontThick = "thick"

var FontThin = "thin"

var FontThorned = "thorned"

var FontThreePoint = "threepoint"

var FontTicks = "ticks"

var FontTicksSlant = "ticksslant"

var FontTiles = "tiles"

var FontTinkerToy = "tinkertoy"

var FontTombstone = "tombstone"

var FontTrain = "train"

var FontTrek = "trek"

var FontTsalagi = "tsalagi"

var FontTubular = "tubular"

var FontTwisted = "twisted"

var FontTwoPoint = "twopoint"

var FontUSAFlag = "usaflag"

var FontUnivers = "univers"

var FontVarsity = "varsity"

var FontWavy = "wavy"

var FontWeird = "weird"

var FontWetLetter = "wetletter"

var FontWhimsy = "whimsy"

var FontWow = "wow"

var PaletteDefault = White

var ProfileMap = map[string]Palette{
	"mint":       PaletteMintGreen,
	"matrix":     PaletteMatrixGreen,
	"bog":        PaletteBogGreen,
	"swamp":      PaletteSwampGreen,
	"ice":        PaletteIceBlue,
	"desert":     PaletteDesert,
	"retro":      PaletteRetroIcyPole,
	"google":     PaletteGoogle,
	"default":    PaletteDefault,
	"red":        PaletteRed,
	"green":      PaletteGreen,
	"blue":       PaletteBlue,
	"yellow":     PaletteYellow,
	"purple":     PalettePurple,
	"red-black":  PaletteRedBlack,
	"red-orange": PaletteRedOrange,
	"pizza":      PalettePizza,
	"patriot":    PalettePatriot,
}

Functions

func GetFonts

func GetFonts() []string

func MatchFont

func MatchFont(name string) string

func ParseFlf

func ParseFlf(fontName string, gz string) (*font, error)

ParseFlf parses a FIGlet font file

func Print

func Print(args Args)

func Random

func Random(args Args)

Types

type Args

type Args struct {
	Message    string
	Font       string
	Palette    Palette
	ColourMode ColourMode
	Trim       bool
	Verbose    bool
}

type ColourMode

type ColourMode int64

func GetColourMode

func GetColourMode(p string) ColourMode

type Palette

type Palette struct {
	Name       string
	Key        string
	Colours    []string // List of Hex Codes to use in scheme
	ColourMode ColourMode
}

func GetPalette

func GetPalette(p string) Palette

func (*Palette) IsEmpty

func (c *Palette) IsEmpty() bool