Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acxz/pokeshell
A featureful shell program to show pokemon sprites in the terminal.
https://github.com/acxz/pokeshell
bash colorscripts krabby pokeget pokemon pokemon-colorscripts pokemon-coloscripts pokemon-icat pokemonshow pokescript pokeshell poketerm shell shell-script terminal
Last synced: 29 days ago
JSON representation
A featureful shell program to show pokemon sprites in the terminal.
- Host: GitHub
- URL: https://github.com/acxz/pokeshell
- Owner: acxz
- License: gpl-3.0
- Created: 2022-02-27T01:04:47.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T12:24:13.000Z (about 2 months ago)
- Last Synced: 2024-10-23T02:02:46.860Z (about 2 months ago)
- Topics: bash, colorscripts, krabby, pokeget, pokemon, pokemon-colorscripts, pokemon-coloscripts, pokemon-icat, pokemonshow, pokescript, pokeshell, poketerm, shell, shell-script, terminal
- Language: Shell
- Homepage:
- Size: 71.3 KB
- Stars: 132
- Watchers: 4
- Forks: 9
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-linux-ricing - pokeshell - A featureful shell program to show pokemon sprites in the terminal. (Terminal / Fancies)
README
# pokeshell
A shell program to show pokemon sprites in the terminal.
Key features include:
| ✔️ animated sprites | ✔️ multiple pokemon | ✔️ multilingual | ✔️ terminal fit | ✔️ tab completions |
|:-:|:-:|:-:|:-:|:-:|
## Dependencies
| - [bash](https://www.gnu.org/software/bash/) | - [curl](https://curl.se/) | - [jq](https://stedolan.github.io/jq/) | - [imagemagick](https://imagemagick.org/) | - [timg](https://github.com/hzeller/timg)/[chafa](https://github.com/hpjansson/chafa/) |
|:-:|:-:|:-:|:-:|:-:|
## Installation
You can install/uninstall pokeshell using [`just`](https://github.com/casey/just).
By default the install directory is `/usr/local/`, which will allow you to run `pokeshell`
anywhere on your system as well as add shell completions.
You can also specify the install directory, but you'll have to make sure that directory is on your `$PATH`
if you want to run `pokeshell` from anywhere.
```bash
# install
just install []
# uninstall
just uninstall []
```
If you don't have `just` or don't want to use it, you can directly use the `install.sh` and `uninstall.sh` scripts.
```bash
# install
./install.sh [install_dir]
# uninstall
./uninstall.sh [install_dir]
```
Remember to prepend the install/uninstall command with `sudo` if you need to.
If you do not want to install then you can still run pokeshell anywhere
by adding the following lines to your `~/.bashrc`.
```bash
export PATH=/path/to/pokeshell:$PATH
```
## Usage
```bash
pokeshell --help
```
or if running from this directory:
```bash
./bin/pokeshell --help
```
## Examples
## Integration
### hyfetch
[hyfetch](https://github.com/hykilpikonna/hyfetch) is an active fork of
[neofetch](https://github.com/dylanaraps/neofetch). Most importantly, it
has fixes for properly displaying ascii. The updated `neofetch` can be run
with the [`neowofetch`](https://github.com/hykilpikonna/hyfetch#running-updated-original-neofetch)
command and uses your existing `neofetch` config.
To use `pokeshell` with `hyfetch` add the following to your `neofetch`
config file: `~/.config/neofetch/config`:
```
image_backend="ascii"
image_source=$(POKESHELL_COMMAND)
```
where `POKESHELL_COMMAND` is what you would run in the terminal.
For example, including the below in your `neofetch` config file
```
image_backend="ascii"
image_source=$(pokeshell politoed)
```
and running `neowofetch` gives the following:
## Sources
A great amount of gratitude goes to the following projects, without which
`pokeshell` would not be possible. Please star/support these sources!
Small sprites: [msikma/pokesprite](https://github.com/msikma/pokesprite)
Big sprites and localization: [PokeAPI](https://pokeapi.co/)
- Specifically: [PokeAPI/pokeapi](https://github.com/PokeAPI/pokeapi) and [PokeAPI/sprites](https://github.com/PokeAPI/sprites)
Animated sprites: [ProjectPokemon](https://projectpokemon.org/home/docs/spriteindex_148)
## Similar Projects
pokeshell is not the first player in the pokemon shell art niche and nor will it
be the last. (I just hope that the next project can take these ideas and only
expand on them.) Below is a feature list of some projects (
[acxz/pokescript](https://github.com/acxz/pokescript),
[phoneybadger/pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts),
[talwat/pokeget-rs](https://github.com/talwat/pokeget-rs))
that also fill this role and what makes `pokeshell` unique among them.
| **Feature** | **pokeshell** | **pokescript** | **colorscripts** | **pokeget-rs** |
|:----------------:|:-------------:|:--------------:|:----------------:|:--------------:|
| random | ✔️ | ✔️ | ✔️ | ✔️ |
| small | ✔️ | ✔️ | ✔️ | ✔️ |
| big | ✔️ | ❌ | ❌ | ❌ |
| animated | ✔️ | ❌ | ❌ | ❌ |
| terminal fit | ✔️ | ❌ | ❌ | ❌ |
| multilingual | ✔️ | ✔️ | ❌ | ❌ |
| genders | ✔️ | ✔️ | ❌ | ❌ |
| tab completion | ✔️ | ✔️ | ❌ | ❌ |
| multiple pokemon | ✔️ | ✔️ | ❌ | ✔️ |
| no internet | ❌ | ✔️ | ✔️ | ✔️ |
| block size # | ANSI | half | half | half |
| # dependencies - | 5 | 1 | 1 | 0 |
| cached speed + | 1x (76.9 ms) | 11x (7.1 ms) | 2x (37.5 ms) | 37x (2.1 ms) |
| first run speed + | 1x (241.2 ms) | 34x (7.1 ms) | 6x (37.5 ms) | 115x (2.1 ms) |
#: in order of resolution: ANSI > half
-: pokeshell/pokescript uses bash, colorscripts uses python, pokeget-rs uses rust
+: Normalized to pokeshell, tested with [hyperfine](https://github.com/sharkdp/hyperfine), larger
is faster
### Other Similar Projects
- [aflaaq/pokemon-icat](https://github.com/aflaaq/pokemon-icat)
Show Pokemon sprites in Kitty
- [eramdam/pokemonshow](https://github.com/eramdam/pokemonshow)
Show Pokemon sprites using JavaScript
## Other Pokémon Sprite Terminal Projects
- [rmccorm4/Pokefetch](https://github.com/rmccorm4/pokefetch)
Fetch Pokedex entries in your terminal
- [HRKings/pokemonsay-newgenerations](https://github.com/HRKings/pokemonsay-newgenerations)
Cowsay for Pokemon
- [31marcobarbosa/pokeTerm](https://github.com/31marcobarbosa/pokeTerm)
Display random Pokemon sprite upon opening a terminal