df4ed54b0c
Update README.md |
||
---|---|---|
.idea | ||
Data | ||
Images | ||
Samples | ||
Scripts | ||
.gitignore | ||
database.py | ||
LICENSE | ||
main.py | ||
pokemon | ||
README.md | ||
scripter.py | ||
unittest.py |
Pokemon-Terminal
Sample Set #1 | Sample Set #2 |
---|---|
Features
- 493 unique Pokemon
- Select Pokemon by name or by index number
- Ability to change the Desktop Wallpaper & the Terminal background
- Internal search system for finding Pokemon
How to Install
- Make sure you have Python 3.5 or higher.
- Make sure you have iTerm2.
- Copy and paste the following for the installation:
# Pokemon Installation git clone https://github.com/LazoCoder/Pokemon-Terminal $HOME/.Pokemon-Terminal echo PATH="$HOME/.Pokemon-Terminal:${PATH}" >> ~/.bash_profile source ~/.bash_profile
- Now you can change the terminal background like so:
$ pokemon pikachu
Usage
Usage:
pokemon [parameter]
Parameters:
[name] - Change the terminal background to the specified Pokemon.
[index] - Change the terminal background to a Pokemon by its index.
[region] - List all the Pokemon of the specified region.
[one letter] - List all Pokemon who's names begin with a particular letter.
[two letters] - List all Pokemon who's names begin with those two letters.
Other Parameters:
pokemon all - List all the Pokemon supported.
pokemon regions - List all the available regions.
pokemon extra - List all the Pokemon from the 'Extra' folder.
pokemon random - Change the terminal background to a random Pokemon.
pokemon ? - Identify the current Pokemon in the terminal.
pokemon _pikachu - Change the wallpaper to the specified Pokemon.
pokemon _random - Change the wallpaper to a random Pokemon.
pokemon _? - Identify the current Pokemon in the wallpaper.
pokemon slideshow - Iterate through each Pokemon.
pokemon slideshow-kanto - Iterate through each Pokemon in the specified region.
pokemon help - Display this menu.
Example:
Suggestions
I highly suggest making the font colors black and the terminal window transparent. Some of the images have both light and dark colours and so it can be difficult to see the text sometimes. Transparency resolves this issue. Since Pokemon Terminal only changes the background, the transparency must be done manually:
- Navigate to iTerm2 > Preferences > Profiles > Window
- Set the transparency to about half way.
- Hit the "blur" checkbox.
- Set the blur to maximum.
The result should look like this:
Adding Custom Images
The folder Images/Extra is for adding custom images. You can manually add backgrounds to this folder and they will be visible to the program. Only PNG format is supported. To see a list of all the custom backgrounds type:
$ pokemon extra
Alternatively, you can delete images from this folder and it will not break the program. These are some custom backgrounds:
Solutions for Issues
If you experience a line at the top of the terminal after changing the Pokemon, you can remove it by typing in the clear command or opening a new terminal.
Saving
I have not yet implemented a way to save the background to a profile. To save a background you will need to setup a startup command in the profile.
- Navigate to iTerm2 > Preferences > General
- Locate the field where it says Send text at start under Command.
- In that field type "pokemon [pokemon name]". You can see an example in the image down below.
- You can leave out "; clear" if you don't care about the line showing up at the top of the terminal.
Notes & Credits
- Nearly all of the Pokemon backgrounds were created by Teej.
- Originally the images were about 100mb in total but I used pngquant to compress them down to about 30mb.
- Since the images are compressed, a few of them have some mild compression artifacts.
- Special thanks to @DrMartinLutherXing for some bug fixes