Pokemonc

Pokemonc is mostly a C rewrite of phoney badger's pokemon-colorscripts with some extra features. I developed it for the terminal startup display. I didn't find the C version of the program, so I tried to implement this project. Pokémon was a part of my childhood and I love it!

Table of contents

• Features
• Installation
  • Ubuntu/Debian x86_64 (and derivatives)
  • Installing from script (other distros)
• Usage
• Credits
• Similar projects

Features

• Pokemon from every generation, including shinies, megas, gigantamax, and regional variants
• Print random pokemon (with filters for generations and different forms)
• Print pokemon by name
• Print pokedex entry together with the sprite
• Configuration file, right now only for language and shiny rate

Installation

Ubuntu/Debian x86_64 (and derivatives)

Download the latest .deb release. Then run (replacing v.v.v with the version number)

dpkg -i pokemonc_v.v.v_amd64.deb
# dpkg -r pokemonc

Installing from script (other distros)

If you are using a Linux distribution other than Ubuntu/Debian or its derivatives, or you prefer to install the project from the source code, follow the steps below to install pokemonc using the provided install.sh script.

1. Clone the repository First, clone the project repository to your local machine using the following command:

git clone https://github.com/JJLibra/Pokemonc.git pokemonc
cd pokemonc

2. Run the install script The installation script install.sh will copy the pokemonc binary to a system-wide location and set up the necessary configuration files in your home directory. This script will:

• Copy the pokemonc binary to /usr/local/bin/, allowing you to run pokemonc from anywhere in the terminal.
• Copy the assets folder and config.json to the ~/pokemonc directory in your home folder.

sudo ./install.sh
# sudo ./uninstall.sh

Other

The current project does not support Windows and Mac systems. And the other installations are looking for. Of course, you are welcome to provide it to me.

Usage

Run the help command pokemonc --help to see the following help message.

USAGE:
    pokemonc <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -v, --version    Print version information

SUBCOMMANDS:
    help             Print this message or the help of the given subcommand(s)
    list             Print list of all pokemon
    name             Select pokemon by name. Generally spelled like in the games.
    random           Show a random pokemon.

To get more detailed information about a subcommand you can also view its help, for example

pokemonc random --help

To get the help of the random subcommand.

Examples

Print a specific pokemon

pokemonc name charizard
pokemonc -n charizard

Print a specific shiny pokemon

pokemonc name spheal -s
pokemonc -n spheal -s

Print a specific pokemon together with its pokedex entry

pokemonc name mudkip -i
pokemonc -n mudkip -i

Print an alternative form of a pokemon

pokemonc name blastoise -f mega
pokemonc name mewtwo -f mega-x

Print a random pokemon (gens 1-9)

pokemonc random
pokemonc -r

Print random pokemon from generations 1-3

pokemonc random 1-3
pokemonc -r 1-3

Print a random pokemon from generations 1,3 and 6

pokemonc random 1,3,6
pokemonc -r 1,3,6

Print a random pokemon excluding megas, gigantamax and regional variants

pokemonc random --no-mega --no-gmax --no-regional

Print a random pokemon together with its pokedex entry

pokemonc random -i
pokemonc -r -i

Configuration

When the program is run, a configuration file will automatically be created in the user's config directory (usually ~/.config) under pokemonc/config.json if it doesn't exist already.

{
	"language": "en", // en (English), fr (French), de (German), ja (Japanese), zh_hans (Chinese with simplified characters), zh_hant (Chinese with traditional characters)
	"shiny_probability": 0.01
}

Credits

The pokemon sprites for pokemonc were generated using sprites from PokéSprite and converted to unicode using Phoney Badger's pokemon-generator-scripts. The pokemon data was obtained from PokéAPI.

Similar projects

• pokemon-colorscripts
• krabby
• pokeget
• pokeshell