Skip to content
This repository has been archived by the owner on Aug 9, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (31 loc) · 1.9 KB

DEVELOPING.md

File metadata and controls

50 lines (31 loc) · 1.9 KB

Development docs

What pokeget does behind the scenes

Basically, pokeget first checks the first argument if it is a special command like update, and if none of the special commands have been called it assumes the user wants a pokemon.

Then, it will first set the default values for stuff like the shiny value, and then generate & import a config file.

After, it loops through all of the arguments ($@) and checks if any of them are a flag like shiny. If they are, it sets the value.

Some flags like variant instead set a variable which will then set the next argument after to the value.

The sprites

The sprites are just text files which are converted using a python script. The sprites can be found here.

The sprites use two of a unicode symbol (██) which in terminals looks like a perfect square.

All of the sprites require true-color support from the terminal, as without it they look weird and off-color.

Developer Dependencies

pokeget utilizes pre-commit for GitHub actions and checking code, which requires Docker and pre-commit installed. This will make your life easier since you can easily check if your code is up to standards and properly formatted.

pre-commit will also fix formatting issues for you, which is nice.

The Makefile needs dpkg, dpkg-dev, rpm, and brew for making all packaged versions of pokeget.

Full list

Recommended Dependencies:

  • coreutils
  • make
  • curl
  • docker
  • pre-commit

Dependencies for packaging pokeget:

  • dpkg-dev
  • dpkg
  • rpm
  • brew