Skip to content

Latest commit

 

History

History
202 lines (148 loc) · 6.43 KB

README.md

File metadata and controls

202 lines (148 loc) · 6.43 KB
Raw

PogoData

PogoData is a Python module that allows developers to easily integrate up-to-date Pokémon GO data in their projects. This includes all kinds of info about Pokémon, Raids, Grunts, Moves, Types or Items. It gets that data from the Protos, GameMaster, APK text files and my pogoinfo repo.

pip install pogodata

Quick Guide

This is a guide on how to use this module. A proper wiki will follow.

Termology

  • "template": the string-IDs used in the Proto. In the GameMaster they're referred to as tempplateId. E.g. BULBASAUR, PIKACHU_NORMAL, ITEM_POKE_BALL
  • "mon": Pokémon
  • "grunt": A NPC you can battle (Team Rocket guys, Team leaders)

Initializing

Everything happens within the PogoData class. You can import it and initialize with a language, which must be one of these. Default is english

>>> from pogodata import PogoData
>>> data = PogoData(language="german")

If your script is running 24/7, you might want to stay updated and reload data every so often. You can do that with PogoData.reload(), which also accepts a language.

>>> data.reload(language="english")

Fetching specific data

In-game objects

For most objects, there's a PogoData.get_xxx() function. They all work the same: You give it an attribute and its value of an object you're looking for and get one that matched this search. Below is a list of objects and their attributes you can refer to.

If nothing is found, None is being returned.

>>> data.get_item(id=1).name
'Poké Ball'

>>> data.get_type(template="GRASS").id
12
# Type templates are saved as `POKEMON_TYPE_XXX` but the function also accepts just XXX
    
>>> data.get_move(name="Ice Punch").template
'ICE_PUNCH'
Pokémon

Since there can be multiple forms of a Pokémon (e.g. Venusaur, Shadow Venusaur, Clone Venusaur, Mega Venusaur), there's an get_all options, if you want to get a list with all Pokémon that match your search.

>>> mons = data.get_mon(get_all=True, id=3)
>>> [(m.template, m.name) for m in mons]
[('VENUSAUR', 'Venusaur'), ('VENUSAUR', 'Mega Venusaur'), ('VENUSAUR_COPY_2019', 'Venusaur'), ('VENUSAUR_NORMAL', 'Venusaur'), ('VENUSAUR_NORMAL', 'Mega Venusaur'), ('VENUSAUR_PURIFIED', 'Venusaur'), ('VENUSAUR_PURIFIED', 'Mega Venusaur'), ('VENUSAUR_SHADOW', 'Venusaur')]

>>> data.get_mon(id=3).template
'VENUSAUR'

Additionally, ever since Shadow Forms have been released, some Pokémon's default forms are 0, while others have the NORMAL type, which gives them an unique Form ID. The PokeMiners would call this the Shadow Treatment, that some Pokémon receive.

Using PogoData.get_default_mon() you can get the default form used by the game.

>>> data.get_default_mon(name="Bidoof").form
0
>>> data.get_default_mon(name="Venusaur").form
169
# Venusaur's template would be 'VENUSAUR_NORMAL'

Icons

Supported

Name Type Pokemon Item Type Weather Grunt
POGO POKEMINERS ✅ ✅* ✅ ✅ ❌
POGO_OPTIMIZED PMSF ✅ ✅ ❌ ❌ ❌
POGO_OUTLINE PMSF ✅ ✅ ❌ ❌ ❌
HOME PMSF ✅ ✅ ❌ ❌ ✅
HOME_OUTLINE PMSF ✅ ✅ ❌ ❌ ✅
SHUFFLE PMSF ✅ ✅ ❌ ❌ ✅
SUGMIORI_OPTIMIZED PMSF ✅ ❌ ❌ ❌ ❌
DERP_AFD PMSF ✅ ❌ ❌ ❌ ❌
DERP_FLORK PMSF ✅** ❌ ❌ ❌ ❌

* Item icons are taken from POGO_OPTIMIZED

** May not be updated

Raw

If you want to get raw Proto Enums, Gamemaster entries or locale data, you can use PogoData.get_enum(), PogoData.get_gamemaster() and PogoData.get_locale().

  • get_enum(enum, reverse=False)

    Takes an enum-name and looks fo it in the Protos, then converts its data to a dict, that looks maps a template (str) to an ID (int). If reverse = True, the keys and values are getting reverse to map an ID to a template. The enum search is case insensitive. Returns and emoty dict if no enum is found.

  • get_locale(key) Returns the translation of key based on the in-game locale files (english). Case insensitive. Returns "?" If they key is not found.

  • get_gamemaster(pattern, settings=None) tbd

Overview

Pokemon

Attributes

  • id
  • template
  • name
  • raw
  • form
  • costume
  • base_template
  • quick_moves
  • charge_moves
  • moves
  • types: A list of Type objects belonging to the Mon
  • evolutions: All Pokémon the Mon can evolve to (including the whole family)
  • temp_evolutions: All Pokémon this Mon can be mega-evolved to
  • asset_value
  • asset_suffix
  • asset: The asset name used by the game. E.g. pokemon_icon_001_00
  • temp_evolution_id
  • temp_evolution_template
  • type: PokemonType.UNSET, PokemonType.BASE, PokemonType.FORM, PokemonType. TEMP_EVOLUTION, PokemonType.COSTUME
  • stats: (attack, defense, stamina)

Methods

  • copy

Grunt

Attributes

  • id
  • template
  • name
  • raw
  • gender: female = 0, male = 1
  • boss: False for normal grunts, True for TR leaders
  • type: BasicType.UNSET, BasicType.SET
  • active: True if the grunt is currently available to battle in-game. False if not
  • team: A list of Pokemon objects looking like this: [[Pokemon, Pokemon], [], []]. Each sub-list represent one team-slot
  • reward_positions: A list of indexes showing which slots of the team are avcailable as rewards
  • rewards: A list of Pokemon that can be encountered after defeating the grunt

Type (as in, Pokemon Type)

Attributes

  • id
  • template
  • name

Item

Attributes

  • id
  • template
  • name

Move

Attributes

  • id
  • template
  • name
  • raw
  • type: The Pokemon Type belonging to the Move

Weather

Attributes

  • id
  • template
  • name
  • raw
  • type_boosts: A list of Types the Weather condition boosts

Specials

PogoData.raids

Can be iterated through to return a tuple of (Raidlevel, Pokemon)

>>> list(data.raids)
[(1, Pokemon), (5, Pokemon). (6, Pokemon)]

All Pokemon of a specific Raid Level can be fetched like this:

>>> data.raids[3]
[Pokemon, Pokemon, Pokemon]