PokeAlarm Version 3.2 Quick Start Guide

Updated: 18 July 2017

Purpose

• This document is intended to quickly provide PokeAlarm users with info to get started. It is not intended to replace the full wiki.

Overview

• Before you begin
• Notes
• Introduction
  • Upgrading from 3.1
  • Filters
  • Alarms

Before you begin

• Version 3.2 is now in the master branch. Read the patch notes if you are upgrading from version 3.
• Features are constantly being added. Always visit the #announcements discord channel for udpates
• Contact us in the #troubleshooting discord channel or open a ticket on our github page

Notes

• Remember - you only need to edit the JSON, geofence.txt, and config.ini files. Other modifications to the code are not supported!!!
• PyCharm is a great IDE to manage your JSON and config files. The EDU edition is free: https://www.jetbrains.com/pycharm-edu . This will will help you avoid those pesky formatting errors.
• Alternatively, use an online JSON editor like http://www.jsoneditoronline.org which will yell at you if the json is incorrectly formatted

Introduction

PokeAlarm v3.2 introduces support for

• Raid alarms
• New Dynamic Text Substitution for pokemon CP, level and more gym information

Upgrading from 3.1

1. Update PokeAlarm git pull
2. Make sure requirements are in oder pip install -r requirements.txt
3. Change the configuration with the new raid filters - see the information below
4. (Optional) modify your alarms.json to customize egg and raid messages.

Updating Filter Configuration

To use 3.2, existing filters.json file must be updated with the two new sections describing eggs and raids in filters.example.json. Either copy the new sections into your existing configuration(s) or start from scratch by making a copy of the example file.

The filter following new egg filters are available:

• min_level: An integer describing the minimum level of the raid you want to send alarms about. Raids with a lower level will not be sent
• max_level: An integer describing he maximum level of the raid you want to send alarms about. Raids with a higher level will not be sent

Example eggs filter:

 "eggs": {
         "enabled":"True",
         "min_level": "1",
         "max_level": "5"
 },

The default pokemon filter is used for raids and kept the same way as pokemon filters for simplicity, but some values like iv and size will not have a meaningful use. Raid pokemon will only report CP and have perfect IVs.

See the pokemon filter documentation ([Filters] ) for more information.

Example raids filter:

"raids":{
        "enabled":"True",
        "default": {
            "min_dist":"0", "max_dist":"inf", "min_cp": "0", "max_cp": "999999", "min_iv":"0", "max_iv":"100",
            "min_atk": "0", "max_atk":"15", "min_def": "0", "max_def":"15", "min_sta": "0", "max_sta":"15",
            "quick_move": null, "charge_move": null, "moveset": null,
            "size": null, "gender": null, "form": null, "ignore_missing": "False"
        },
        "Bayleef":"True",
        "Croconaw":"True",
        "Magikarp":"True",
        "Quilava":"True",
        "Electabuzz":"True",
        "Exeggutor":"True",
        "Magmar":"True",
        "Muk":"True",
        "Weezing":"True",
        "Alakazam":"True",
        "Arcanine":"True",
        "Flareon":"True",
        "Gengar":"True",
        "Jolteon":"True",
        "Machamp":"True",
        "Vaporeon":"True",
        "Blastoise":"True",
        "Charizard":"True",
        "Lapras":"True",
        "Rhydon":"True",
        "Snorlax":"True",
        "Tyranitar":"True",
        "Venusaur":"True"
    }

Alarms

if you want custom alarm messages you can use dynamic text substitution as with existing alarms. There are two new messages to set up:

• egg - Alarm when a raid battle is announced - only contains raid level and start/end times but no pokemon
• raid - Alarm when a pokemon battle has started in a gym. Contains raid level, start and end times and pokemon information

For raid messages you can use the same keywords as pokemon alarms, including cp and moves.

Additionally there are a few new keywords:

• <raid_level>: Puts in the level of the raid
• <begin_24h_time>, <begin_12h_time>, <begin_time_left> the time for the raid start in 24 hour, 12 hour and time left until start.

The following is the default alarms for egg and raid in Discord:

Egg

"egg": {
    "username": "Egg",
    "content": "",
    "icon_url": "https://raw.githubusercontent.com/kvangent/PokeAlarm/master/icons/egg_<raid_level>.png",
    "avatar_url": "https://raw.githubusercontent.com/kvangent/PokeAlarm/master/icons/egg_<raid_level>.png",
    "title": "Raid is incoming!",
    "url": "<gmaps>",
    "body": "A level <raid_level> raid will hatch <begin_24h_time> (<begin_time_left>)."
}

Raid

"raid": {
    "username": "Raid",
    "content": "",
    "icon_url": "https://raw.githubusercontent.com/kvangent/PokeAlarm/master/icons/<pkmn_id>.png",
    "avatar_url": "https://raw.githubusercontent.com/kvangent/PokeAlarm/master/icons/egg_<raid_level>.png",
    "title": "Level <raid_level> Raid is available against <pkmn>!",
    "url": "<gmaps>",
    "body": "The raid is available until <24h_time> (<time_left>)."
}