pokete

# Pokete -- Grey Edition Pokete is a small terminal based game in the style of a very popular and old game by Gamefreak. It is a Pokemon-like adventure where you play as a Pokete Trainer, traveling around the world to catch and train as many Poketes as possible, with the ultimate goal of becoming the best trainer. ## Installation You can install Pokete via pip: ```shell pip install pokete ``` Or from the AUR: ```shell $ buildaur -S pokete-git ``` Alternatively, you can run the AppImage from the release page. Note: In that case you first have to create the `~/.cache/pokete/` folder. For Windows, some antivirus software may flag the `libplaysound.dll` as malicious. If pokete crashes, make sure the .dll exists and is not in quarantine. To build a contained executable: ```shell pyinstaller --onefile src/pokete/__main__.py --name pokete --add-binary="src/pokete/playsound/libplaysound.x86_64.so:." --add-data="src/pokete/assets:pokete/assets" ``` If you have problems with your architecture, you may need to rebuild the audio module (see playsound/README.md). ## Running locally ```shell pip install scrap_engine git clone https://github.com/lxgr-linux/pokete.git cd pokete/src python -m pokete ``` ## Usage The game can be run normally without any options. For non-gameplay related usage, use `--help`. You can also try it out online at Replit. ## How to play You start with a starter Pokete (Steini) and use W, A, S, D to move around. When entering high grass (;), you may encounter wild Poketes. Press `1` to choose attacks (as long as AP is above 0). You can kill wild Poketes to gain XP and level up, or weaken them and throw a Poketeball to catch them. Press `1` to view your current deck, see detailed information, and rearrange your Poketes. Changes are saved when quitting via the exit function. You can fight other trainers (appearing as 'a') when you get close. Trainer fights give double XP and you cannot run from them. Heal your Poketes at the Pokete Center (the house) by talking to the person there and choosing the healing option. You can also view all your Poketes there, not just the six in your team. Press `e` to open a menu where you can change your player name and other settings. Red balls on the map are Poketeballs; stepping on them adds them to your inventory. See the How to Play documentation for more details. ## Game depth Poketes have different types that are effective or ineffective against others. The type chart includes Normal, Stone, Plant, Water, Fire, Ground, Electro, Flying, Undead, and Ice types, each with strengths and weaknesses. ## Mods Mods can be written to extend Pokete. Place mods in the `mods` folder and enable them in the menu. See example.py for an example mod. ## Tips - Press any key to advance conversations - Don't play on full-screen; the game may not run properly - Don't be offended by other trainers; they may swear at you ## TODO Completed features include a wizard at start, types for attacks and Poketes, evolving, multiple Poketes for trainers, coloured Poketes, a store, potions, intro, trading, Poketedex, effects, and colour codes for types. More maps are still planned. ## Dependencies Pokete depends on python3 and the `scrap_engine` module. On Windows, `pynput` must also be installed. ## Documentation Documentation is available for pokete_classes, pokete_data, the util file, pokete_general_use_fns, and the main file pokete.py. ## Releases See the Changelog for release information. ## Contributing Contributions are welcome, especially new Pokete contributions located in /pokete_data/poketes.py. See the development guide for adding more poketes/types/attacks. After adding new content, you may run `./util.py wiki` to regenerate the wiki. ## Migrating to flatpak Move your `~/.local/share/pokete/pokete.json` to `~/.var/app/com.github.lxgr_linux.pokete/data/pokete/pokete.json`. ## Credits Music by Eric Skiff, Marllon Silva (xDeviruchi), and SketchyLogic. ## Troubleshooting If you experience problems on Japanese systems, see the linked gist.