Awesome
<h1 align="center"> 📖 Poketex </h1> <p align="center"> Simple Pokedex based on TUI(Terminal User Interface) </p> <p align="center"> <img src="https://img.shields.io/github/actions/workflow/status/ckaznable/poketex/CI.yml?style=flat-square" /> <img alt="Crates.io" src="https://img.shields.io/crates/v/poketex?style=flat-square"> <img alt="Crates.io" src="https://img.shields.io/crates/l/poketex?style=flat-square"> </p>
Table of Contents
- Feature
- Installation
- Usage
- Keyboard Navigation Instructions
- Roadmap
- Troubleshoot
- Pokemon data source
- License
Feature
- All Pokemon (until Pokemon SV)
- All Region Form (until Pokemon SV)
- Searchable
- include English, Chinese, Japanese locales data
Installation
Install from Github Release
Download the last version binary depending on your configuration here: Release Page
Then you just need to enter this command in your terminal:
tar -xf <downloaded_archive> poketext
sudo mv poketex /usr/local/bin
sudo mkdir -p /usr/local/share/poketex/colorscripts
sudo cp -rf colorscripts /usr/local/share/poketex
Install from crates.io
If you're a Rust programmer, poketex can be installed with cargo.
cargo install poketex --locked
Install from the AUR
If you're using Arch Linux, you can install poketex from the extra repository using pacman:
pacman -S poketex
Install from Source Code
poketex is written in Rust, so you'll need to grab a Rust installation in order to compile it.
git clone https://github.com/ckaznable/poketex
cd poketex
make build
sudo make install
If you want to uninstall
sudo make uninsall
Usage
Usage: poketex [OPTIONS]
Options:
-l, --locale <LOCALE> locales [zh, ja, en] [default: en]
-h, --help Print help
-V, --version Print version
Keyboard Navigation Instructions
Use arrow keys or hjkl to move around.
Press Page Up or Page Down to move 4 steps at a time.
Press f to switch ascii forms.
Press E to toggle list showing.
Press A to toggle ability showing.
Press V to toggle IV showing.
Press q to exit.
Press H to display help information.
Press gg to go to the top and G to go to the bottom.
Press alt+j or alt+k to scroll up or down ability description.
Press / to enter search mode.
RoadMap
- show pokemon iv and type
- pokemon list searchable
- add pokemon ability rows
- add region form
- Alola
- Galar
- Hisuian
- Paldea
- add cli flags
- --locale [en, ja, zh]
- for controlling layout
- help key
- gen 9 DLC - The Teal Mask
- gen 9 DLC - The Indigo Disk
- Image support
- Gen 8 and below(powered by pokemon-colorscripts)
- Gen 9(#58, Creator Caruban)
Troubleshoot
Image are not displaying
If the ansi images are not displaying, please copy the colorscripts folder from this repository to /usr/local/share/poketex.
git clone https://github.com/ckaznable/poketex
cd poketex
mkdir -p /usr/local/share/poketex/colorscripts
cp -rf colorscripts /usr/local/share/poketex
Pokemon data source
data generated from ckaznable/poke-data-crawler