Giter Club home page Giter Club logo

ansi-art's Introduction

ANSI ART

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

Steps:

  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 existing art files directly which is available inside repo: '/src/arts/'.

Examples:

// Using existing art
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 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

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.