Giter Club home page Giter Club logo

anime-colorscripts's Introduction

Anime colorscripts

A script to print out images of anime to the terminal. Inspired by Phoney badger's pokemon colorscripts which is inspired by DT's colorscripts compilation

Table of contents

Description

Prints out colored unicode sprites of anime onto your terminal. Contains almost 900 anime from gen 1 to gen 8. Has all the animes you could ever want (okay it doesn't have shiny anime or different forms, but cut me some slack)

Visuals

Demo GIFs

Demo of the program being used

demo of program in action

Demo of the program running on terminal startup.

demo of random animes on terminal spawn

Screenshots

screenshot screenshot screenshot screenshot

Requirements

The program itself is just a shell script that prints out custom color formatted text files. So as long as you have a POSIX compliant shell like dash, bash, zsh etc. as your shell and have coreutils (might not be present on your system if using MacOs. See installation instructions for MacOS for more details), the script should work. You will however need a terminal with true color support, which most modern terminals have. More on terminals and color support can be found in this gist

Build

Clone or download the repository

git clone https://github.com/mizuday/anime-colorscripts.git

cd into the directory and run the build script

cd anime-colorscripts
./build.sh

Now the program should be builded. You can install by using

sudo ./install.sh

Now the program should be installed. You can check this by using

anime-colorscripts

Which should print out the help page of the program

Install

Download the latest version of the scripts in the Release Section

Extract the tar.gz file

tar -xvzf anime-colorscripts.tar.gz

cd into the directory and run the install script

cd anime-colorscripts
sudo ./install.sh

Now the program should be installed. You can check this by using

anime-colorscripts

Usage

You can run the program from the command line to either display a anime of your choice by specifying the anime name or make it display a random anime.

Usage: anime-colorscripts [OPTION] [ANIME NAME]
    "-h, --help, help" "Print this help." \
    "-l, --list, list" "Print list of all anime"\
    "-r, --random, random" "Show a random anime. This flag can optionally be
                    followed by character / anime names (eg. miku, lumi, naruto)
                    this will choose random anime character between all possible
                    outcome"\
    "-n, --name" "Select anime by name."
    "Examples: anime-colorscripts --name 2997-hatsune-miku-wtf"
    "          anime-colorscripts -r"
    "          anime-colorscripts -r miku"
    "          anime-colorscripts -r miku naruto"
    "          anime-colorscripts -r miku naruto lumi"

Example of printing out a specific anime

anime-colorscripts -n 2997-hatsune-miku-wtf

Example of printing out a random anime

anime-colorscripts -r

Example of printing out a random anime with specific anime

anime-colorscripts -r miku

Some anime with spaces or periods or other special characters in their name might not be spelled as expected

These are rare exceptions, and if required you can parse the --list page to see the names of all the anime.

Running on terminal startup

On Bash and ZSH

You can display a random anime whenever a terminal gets launched by adding the anime-colorscripts -r command to your .bashrc or .zshrc.

On Fish

If you have fish as your user shell you can display a random anime on terminal startup by overriding the fish_greeting in your config.fish

function fish_greeting
     anime-colorscripts -r
end

Location of the files

The program is located at usr/local/opt/anime-colorscripts/ with the script being symlinked to /usr/local/bin/

How it works

The program itself is a simple shell script that prints out text files corresponding to the relevant anime or a randomly selected anime. The textfiles formatted with appropriate colors can be found in the colorscripts folder. The sprites were taken from emoji.gg and were converted into text files using a custom python script after some preprocessing. A simple script to scrape and download all the sprites, and a python script to convert these sprites into properly formatted and colored text files, they are also included in the repo and can be found in the src/generator folder.

Depedencies

Author

Juan Louis: https://github.com/mizuday

License

The MIT License (MIT)

anime-colorscripts's People

Contributors

juanlouisr avatar

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.