README
PoGoGram
Setup a Telegram bot that searches for Pokémons in a given area.
Requirements
Telegram bot
You will need a Telegram bot. To create one, just follow these easy steps.
MongoDB
From version v0.4.0 onward, MongoDB is required to run the app. User data is saved, so you don't lose your filters everytime something goes wrong. ;-) You can download and install it here. Instructions here.
Instalation
Simple as it could be.
To install PoGoGram locally, just run npm install pogogram
.
Or, install it globally: npm install -g pogogram
Environment Variables
You must set the following ENV_VARS to use the app.
Variable | Description |
---|---|
PGO_USERNAME | A Pokemón Go account username (PTC or Google) |
PGO_PASSWORD | The password for the account |
PGO_PROVIDER | Account type. 'ptc' for PTC or 'google' for Google |
PGO_TELEGRAM_TOKEN | The token for your Telegram bot |
PGO_MONGODB | The url to your MongoDB instance* |
*If not provided, 'mongodb://localhost:27017/pogogram'
is used.
Using the bot
I'll make it short.
node pogogram.js
or even just npm start
.
Then, in Telegram, just talk with your bot. You will need to set the commands in Telegram too. Just talk to BotFather.
I know commands are hardcoded, and that's why we are in alpha. Also, all texts are in portuguese if you're wondering what language is that. :-)
Features
- Search Pokémons in your area
- Send location (with map), distance and time left
- Filter to ignore some Pokémons
- Set timer to automatically look for Pokémons every 5 minutes
- Search only Pokémons that are near you, in a "catchable" distance
Disclaimer
The app uses an unofficial Pokémon Go API. The account used might be blocked. Do not use you personal account!
Acknowledgment
This is built upon the work of others. Let's give a round of applause to yagop for the excelent node-telegram-bot-api, and brentschooley that created pokespotter.