mortonfox / munztools

Misc tools for Munzee

munztools

Misc tools for Munzee

• diff_myth: Show how many types of mythologicals you have captured on each day in a date range.
• munzee_types: Parse the global Munzee types web page and report on Munzee counts by type and category.
• capture_types: Report on player's captures by type and category.
• deploy_types: Report on player's deploys by type and category.
• munz_info: Retrieve detailed information on a specific Munzee.
• munz_addr: Reverse-geocode the coordinates of a Munzee to get its street address.

Setup

General Setup

Run bundle install to set up the required gems.

You'll also need to obtain a client ID and client secret.

1. Go to the Munzee Developer Dashboard.

2. Click on 'Create App'.

3. Enter the app details as follows:

   • App Name: munztools
   • Description: Misc tools for Munzee
   • Redirect URI: http://localhost:8557/oauth2/callback

4. Click on 'Create App'.

5. Take note of the ID and Secret of the newly created app.

6. Create a text file named .munztools.conf in your home directory.

7. Add the following lines to this file:

   client_id: CLIENT_ID
   client_secret: CLIENT_SECRET

   where CLIENT_ID and CLIENT_SECRET are the ID and Secret you noted above.

Additional setup for munz_addr

munz_addr requires a Bing Maps key. Follow the instructions in Getting a Bing Maps Key. Then add the following line to .munztools.conf:

bing_maps_key: BING_MAPS_KEY

where BING_MAPS_KEY is the key you obtained from the Bing Maps Dev Center.

Usage

For diff_myth usage info:

bundle exec ruby diff_myth.rb --help

For munzee_types usage info:

bundle exec ruby munzee_types.rb --help

For capture_types usage info:

bundle exec ruby player_stats/capture_types.rb --help

For deploy_types usage info:

bundle exec ruby player_stats/deploy_types.rb --help

For munz_info usage info:

bundle exec ruby munz_info --help

For munz_addr usage info:

bundle exec ruby munz_addr --help