pokemongo-notifier's Introduction

Pokemon Go Notification System

This is a fork of jxmorris12/PokemonGo-Finder, a fork of the popular PokemonGo-Map repository, with the purpose of notifying users where to find nearby Pokemon. All API and map functionality was left untouched.

This fork is focused on Slack integration, with the possibility of other integrations in the future.

Config File

Instead of from the command-line, all arguments are read from a config.json file.

See config.json.sample.

Optional arguments:

step_limit: Determines how far the "player" will search. A value of 1 is the same as a stationary player. A value of 2 means the player searches in 4 locations. And etcetera.
notify_distance: Distance in meters within which to send notifications. if set to None will notify on everything.
notify_ignore: Comma-separated list of Pokemon to not send notifications for.
notify_far_ignore: If set along with notify_distance, will notify outside of the notify_distance if the Pokemon does not exist in notify_far_ignore. Useful for rarer pokemon.
notify_schedule: If set, only notifies on specified weekdays and/or hours of the day. See config.json.sample for an example. Weekday of 0 is Monday, and hour of 0 is midnight to before 1am.

It is also recommended to use your own Google Maps API key, set it in credentials.json.

See credentials.json.sample.

Install

Only works with Python 2.7.

Install the necessary dependencies by running pip install --upgrade -r requirements.txt. Create a config file and then run the main script using python main.py.

Using this software is against the ToS and can get you banned. Use at your own risk.

pokemongo-notifier's People

Contributors

Watchers

pokemongo-notifier's Issues

Use nearest PokeStop as location name

Currently, the bot will post the response from the map API as the location name, e.g. "123, Fake Street" or "Starbucks, Fake Street".

This would be more user-friendly if it instead stated the name of the closest PokeStop.

Geocoder exception

Ran into this exception after running for a few days:

Exception in thread search_thread:
Traceback (most recent call last):
  File "C:\tools\Python27\lib\threading.py", line 801, in __bootstrap_inner
    self.run()
  File "C:\tools\Python27\lib\threading.py", line 1073, in run
    self.function(*self.args, **self.kwargs)
  File "main.py", line 588, in main
    pokemonsJSON, ignore, only, notify_ignore)
  File "main.py", line 712, in process_step
    notifier.pokemon_found(pokemon_obj)
  File "c:\dev\pokemongo-notifier\notifier.py", line 30, in pokemon_found
    location = Nominatim().reverse(coords)
  File "C:\tools\Python27\lib\site-packages\geopy\geocoders\osm.py", line 248, in reverse
    self._call_geocoder(url, timeout=timeout), exactly_one
  File "C:\tools\Python27\lib\site-packages\geopy\geocoders\base.py", line 163, in _call_geocoder
    raise GeocoderTimedOut('Service timed out')
GeocoderTimedOut: Service timed out

corresponds to this line: location = Nominatim().reverse(coords)

Need to catch that exception...

Add option for quiet hours

Notifications aren't useful when you're asleep or out of the area. Implement a way to silence notifications via some kind of config option.

Add `always` list of pokemon to never ignore based on distance

Some Pokemon are rare enough that we want to display them even if they exceed the distance_limit. Need to add and handle a new field always in config.json.

Recommend Projects