poketerm 1.0.1
Custom terminal welcome messages, pokemon ASCII art, and random one-liner!
Requires Python: >=3.7

# poketerm
[![PyPI version](https://badge.fury.io/py/poketerm.svg)](https://badge.fury.io/py/poketerm)
[![Downloads](https://pepy.tech/badge/poketerm)](https://pepy.tech/project/poketerm)
[![Downloads](https://pepy.tech/badge/poketerm/month)](https://pepy.tech/project/poketerm/month)
[![Downloads](https://pepy.tech/badge/poketerm/week)](https://pepy.tech/project/poketerm/week)

Get greeted by custom message and/or

Pokemon ascii art and/or

A random one-liner when you switch your terminal on inside a dialog cloud

![alt text](https://github.com/devarshi16/TerminalWelcome/blob/master/poke.png)

### Example output
![Poketerm demo](demo.gif)


## Installation
Alternate installation instructions -> https://youtu.be/JBUYfeah5c8
```
$ sudo pip install poketerm
```
**NOTE:** You need sudo permission for the package to work

Turn on poketerm
```
$poketerm -t 1
```
Poketerm sets `POWERLEVEL9K_INSTANT_PROMPT=quiet` when updating zsh
configs and places it at the top of the file to avoid Powerlevel10k
instant prompt warnings.

Turn off poketerm
```
$poketerm -t 0
```

**NOTE:** make sure to turn off poketerm before you uninstall it!

## Poketerm help
```
usage: main.py [-h] [-p {bulbasaur,dugtrio,meowth,pikachu,noascii}] [-l]
               [-o {0,1}] [-m MESSAGE] [-t {0,1}] [-d {0,1}] [-s]
               [--support]

Display a Custom Message, a Pokemon ASCII Art and a Random Oneliner.
NOTE: Remember to turn off poketerm using -t 0 tag before you uninstall
it

optional arguments:
  -h, --help            show this help message and exit
  -p {bulbasaur,dugtrio,meowth,pikachu,noascii}, --pokemon {bulbasaur,dugtrio,meowth,pikachu,noascii}
                        pokemon name for ASCII art. [noascii] for disabling
                        ASCII art
  -l, --list            list available pokemons
  -o {0,1}, --one-liner {0,1}
                        turn one liner on [1] or off [0]
  -m MESSAGE, --message MESSAGE
                        custom message to be displayed in the start. [nomessage] for
                        no message
  -d {0,1}, --dialog {0,1}
                        turn dialog cloud on [1] or off [0]
  -t {0,1}, --turn-on {0,1}
                        turn on poketerm [1], turn off [0]
  -s, --show            run poketerm with the active configuration
  --support             print sponsor/donation URL and exit
```

## List of available pokemons
```
$ poketerm -l
Available Pokemons are
pikachu

|\_                  _ 
 \ \               _/_|
  \ \_          __/ /
   \  \________/   /
    |              |
    /              |
   |   0       0   |
   |       _       |
   |()    __    () |
    \    (__)      |
bulbasaur
 
            ____M___
           (  /   \ \
     \ ----/\ (    ) )
     / O  O  |---- _/
    |   _         \
     \__U____/ _(  |
      |_/   |_/  |_/
dugtrio

              _______
             /       \
            |  0   0  |
          __|__  <>   | 
         /     \    __|__
        |       |  /     \
        | 0  0  | / 0  0  |
        |  <>   |/   <>   /
        |       |        /
       0oOwwwWwwOOoowwwwww
meowth

                ___                       ___ 
               |   \_    ^        ^     _/   |
               |     \_ | |      | |  _/ __  |
               |       \| | /""\ | | / _/  | |
               |    __..|"||____||"|../.  /  |
         __     \_ /    | ||____|| |    \/ _/    __ 
         \ """--__:      v  \../  v      :__--""" / 
          ""--___/     ____       ____    \___--""
                .     (_||_)     (_||_)    .
        ________|_                        __|_______
        \__________                       _________/
                .        __________        .
                  .      \   __   /      .
                    .     \_/__\_/     .
                      .              .
                        "..........."
noascii
```

## Change Pokemon ASCII art
```
$ poketerm -p meowth
```

## Change Custom Message
```
$ poketerm -m "Your Message Here"
```

Random one-liners and the dialog cloud are enabled by default. Disable them with the following commands or re-enable them as needed.

## Turn off Random One-Liner
```
$ poketerm -o 0
```

## Re-enable dialog cloud
Enabled by default; use this if you've disabled it.
```
$ poketerm -d 1
```

## Turn off dialog cloud
```
$ poketerm -d 0
```

## Turn off pokemon ascii art
```
$ poketerm -p noascii
```

## Turn off Custom Message
```
$ poketerm -m nomessage
```

## Support the Project

Poketerm is completely free and open source. If it brightens up your
terminal and you blaze past 10,000 runs (there's a gentle reminder when
you do!), please consider supporting its continued development.

[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-%E2%9D%A4-ff69b4?style=for-the-badge&logo=github-sponsors)](https://github.com/sponsors/devarshi16)

## Acknowledgments

Thanks to (http://silgro.com/fortunes.txt) for their one-liner database.