Skip to content

Display Pokémon, Pokéballs, berries, potions & more in your terminal.

License

Notifications You must be signed in to change notification settings

Criomby/pokeget-plus

Repository files navigation

pokeget-plus

Display Pokémon, Pokéballs, berries, potions & more items in your terminal.
For example you can get a random Pokémon each time you open a new terminal session.

Pikachu Sableye Arcanine Metang

GreatBall BlukBerry Elixir Honey

... and many more!

Key features:

  • Display Pokémon or items in your terminal with many options
  • Option to use the retro gen7 sprites with --gen7
  • Get Pokémon items with --item [NAME] e.g. get a random Pokéball each time you open a new terminal session
  • Prebuilt binaries for the most common targets
  • + various changes and fixes (see changelog)
  • The sprites are embedded into the binary, so no additional files will have to be downloaded and pokeget runs fully offline

Installation

You have two options:

1. Download the latest binary from releases

2. Build from source

Install via cargo:

cargo install --git https://github.com/Criomby/pokeget-plus.git --locked

and making sure $HOME/.cargo/bin is added to $PATH.

or

clone the repository and compile manually:

git clone --recurse-submodules https://github.com/Criomby/pokeget-plus.git
cd pokeget-plus
cargo build --release --locked

Update with either re-running cargo install ... as above or
git pull on the repository and then recompile.


Tip:

If you don't need the retro gen7 sprites or items, just add the --no-default-features flag and you'll get a smaller file size since those assets won't be embedded into the binary then.
This will save you 1.6 MB (8.7 MB vs. 10.3 MB).


Usage

Pokémon:

pokeget [NAME]

e.g. pokeget pikachu
Use pokeget random for a random Pokémon.

Item:

pokeget --item [category/variation]

e.g. pokeget --item ball/fast or pokeget --item berry/pecha

Use pokeget --item random for a random item or
get a random item from a category with pokeget --item ball/random for a random Pokéball or ... berry/random for a random berry, etc.

With the short item flag: pokeget -i ball/random, pokeget -i berry/golden-razz

-> List of all available items and categories: items-list <-


Advanced Usage

For more info and to see all options, run pokeget --help

You can also use multiple Pokémon / items like:

pokeget bulbasaur pikachu or pokeget --item ball/ultra ball/random

and Pokédex / item ID's work too, e.g.:

pokeget 25 (Pikachu)

pokeget --item 4 or pokeget -i 4 (regular Pokéball)

ID '0' is equal to 'random'.
So you can also use pokeget 0 and pokeget --i 0 to get random results.


Why?

I saw the demand for additional features like displaying a random Pokéball or berry in your terminal when you open a new session and since the original author did not want to include the proposed features, I decided to fork and code myself.
Still, the original author did some great work creating the foundation of this project and I'm grateful for that.

If at any time the original author decides to want to include any added features in the original project, just open an issue and I'll be happy to draft a PR.


Credits

Pokeget-plus is built on the original pokeget-rs.

The sprites are from pokesprite.

Also see the other projects.