# Pokeplot

[![Gem Version](https://badge.fury.io/rb/pokeplot.svg)](https://badge.fury.io/rb/pokeplot) [![Test Coverage](https://codeclimate.com/github/xssc/pokeplot/badges/coverage.svg)](https://codeclimate.com/github/xssc/pokeplot/coverage)  [![Dependency Status](https://gemnasium.com/badges/github.com/xssc/pokeplot.svg)](https://gemnasium.com/github.com/xssc/pokeplot) [![Gem](https://img.shields.io/gem/dt/pokeplot.svg?maxAge=2592000)](https://rubygems.org/gems/pokeplot)

Pokeplot is a gem to collect Pokemon Go spawning data and visualize it. It is currently a pre-release, expect frequent updates.

![Graph Example](http://i.imgur.com/XRp14KV.png)

### Contents

[**Getting Started**](https://github.com/xssc/pokeplot#getting-started)

[**Usage**](https://github.com/xssc/pokeplot#usage)

[**Features**](https://github.com/xssc/pokeplot#features)

[**Notifications**](https://github.com/xssc/pokeplot#notifications)

[**Updating**](https://github.com/xssc/pokeplot#updating)

[**Future and TODO**](https://github.com/xssc/pokeplot#future--todo)

[**Contanct, Requests, and Issues**](https://github.com/xssc/pokeplot#contact-requests-and-issues)

[**Contributing**](https://github.com/xssc/pokeplot#contributing)

## Getting Started

Installing pokeplot is insanley easy. All you need is ruby 2.3.1. Don't have it? [Follow our easy Ruby install guide!](https://github.com/xssc/pokeplot/wiki/Install-Ruby-2.3.1)

We use MongoDB to quickly store large numbers of encounters. Download and install it from [HERE](https://www.mongodb.com/download-center?jmp=nav#community). Don't worry, it's easy!

Once done the only installation command is:

    $ gem install pokeplot --pre

## Usage

Open a terminal/cmd and make a folder for Pokeplot configuration to be stored

    $ mkdir pokeplot
    $ cd pokeplot

Then to generate the default config.json file, run

    $ pokeplot config

Then go to the pokeplot folder you just made and open config.json in your favorite text editor. There are `_info` lines to help you along the way.

Then simply run

    $ pokeplot

Real time graphs will be available at `http://localhost:5001` while pokeplot is running.

## Features
* Single or Multithread
* Divides coordinates in a way that doesn't cause larger teleportations due to more accounts
* Multiple accounts (Combo lists also supported)
* Configurable config.json
* Real time website with graphs
* Ability to handle real time data yourslef with Ruby (Examples soon)
* Notifications
* A developer who has tons of freetime to work on this project!


## Notifications

Currently Pokeplt only supports Pushbullet. [Follow the easy setup guide here](https://github.com/xssc/pokeplot/wiki/Pushbullet)


## Updating

When a update is available for pokeplot, only one command is needed to install it

    $ gem update pokeplot

Pokeplot will be updated frequently, I have lots of spare time.

## Future & TODO
 The following is planned (but not guarenteed)

 * Maps
 * More graphs
 * Get Cell Ids in Ruby
 * Add more notification services
 * Fix any issues that arrise
 * Lots more

## Contact, Requests, and Issues
If you have any problems using this, I will do whatever I can to help you get up and running. Your options are

 * Create an issue [HERE](https://github.com/xssc/pokeplot/issues)
 * Email me @ xssc820@gmail.com
 * Or PM me on reddit at [/u/xssc](https://www.reddit.com/message/compose?to=xssc)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/xssc/pokeplot