Nutritious Pumpkin Masses

    ansi-art

    1.3.0 • Public • Published

    ANSI ART

    npm npm

    Create ANSI art and render it with speech bubbles inside node.

    https://gauravchl.github.io/ansi-art/webapp/

    screen shot 2017-04-25 at 11 51 53 am

    Install

    1. Create and download the ANSI art from webapp: https://gauravchl.github.io/ansi-art/webapp/
    2. Install npm install ansi-art package to render the downloaded art file.
    3. You can also render the pre-made art files in '/src/arts/'.

    Examples

    // Using existing art
    let ANSI = require('ansi-art').default;
    let mario = ANSI.get({artName: 'mario'});
    console.log(mario);
    // Or use it with ES6 module
    import ANSI from 'ansi-art';
    let mario = ANSI.get({artName: 'mario'});
    console.log(mario);
    // Using custom art file
    import ANSI from 'ansi-art';
    let art = ANSI.get({filePath: '~/desktop/custom-art.ansi'})
    console.log(art);
    // Using random art
    import ANSI from 'ansi-art';
    let art = ANSI.get({speechText: 'Hello world'})
    console.log(art);
    // Using Speech bubble
    import ANSI from 'ansi-art';
    let art = ANSI.get({artName: 'mario', speechText: 'Hello world'}
    console.log(art);

    ANSI.get(options)

    Parameter Type Description
    options.filePath string Path to custom ANSI art file(eg: ~/mario.ansi)
    options.artName string Name of existing ANSI art available within package.See available arts
    options.speechText string If provided, render the text inside 'speech bubble' above the ANSI art
    options.speechBubbleOptions object options for speech bubble, See available options here

    screen shot 2017-05-14 at 4 57 37 pm

    Mario credits: https://github.com/acarl005/node-super-mario

    Parrot credits: https://github.com/matheuss/parrotsay-api

    Contributing

    Please feel free to submit any bugs or suggestions as issues or request to add any art into existing collections. Pull requests are welcome.

    Keywords

    Install

    npm i ansi-art

    DownloadsWeekly Downloads

    26

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    173 kB

    Total Files

    17

    Last publish

    Collaborators

    • gauravchl
    • mojoaxel