Pokemon Go Raid Organizer Discord Bot

Introduction

This Discord bot automatically replaces GymHuntrBot's and Mercer County Top Tier Bot's raid announcements with a post that includes a Google Maps URL to the gym and the raid end time.

In addition, this bot supports useful commands that users can enter in any channel to get information about an active raid at a specified gym or locate a gym/raid: +info and +where.

The bot also has the option (currently disabled) to create temporary raid channels for coordinating raid battles. Raid channels that are inactive or are past the raid end time are automatically deleted.

Commands

Key prefix: +

Raid Info

• +info exactGymNameWithSpaces - Get pokemon name, gym name, Google Maps URL, and time information about the active raid at the specified gym. This uses raid announcements by the Mercer County Top Tier Bot, so that bot needs to have found the raid first. e.g. +info Washington's Crossing

• +where exactGymNameWithSpaces to get a Google Maps URL to the gym. Also works with +map and +whereis. e.g. +where doughnut fountain

Channel Management (currently disabled)

• +channel exactGymNameWithSpaces - Creates a raid channel for an active raid at the specified gym. This uses raid announcements by the Mercer County Top Tier Bot, so that bot needs to have found the raid first. For example, +channel Washington's Crossing
• +raid pokemonName locationNoSpaces time - Creates a raid channel with the given pokemon name, location, and time information. The Pokemon does not have to be on the approved list. Make sure to add a Google Maps URL of the gym location to that channel to help Trainers find it. For example, +raid lugia princeton-stadium 7:49pm
• +deleteraids - Deletes all raid channels (as identified by the suffix "__" by default) regardless of state. Requires MANAGE_CHANNELS permission.
• +enableautoraid - Enables automatic raid channel creation from GymHuntrBot's posts (see below). Requires MANAGE_CHANNELS permission.
• +disableautoraid - Disables automatic raid channel creation from GymHuntrBot's posts (see below). Requires MANAGE_CHANNELS permission.

Approved Pokemon List Management (currently disabled)

• +approve listOfPokemonNames - These pokemon will be added to the approved list for making raid channels automatically. Requires MANAGE_CHANNELS permission.
• +disapprove listOfPokemonNames - These pokemon will be removed to the approved list for making raid channels automatically. Requires MANAGE_CHANNELS permission.
• +list - These pokemon are on the approved list for making raid channels automatically. Default: Lugia, Articuno, Zapdos, Moltres, Tyranitar, Mew, Mewtwo, Raiku, Entei, Suicune, Ho-oh, Celebi

Utilities

• +say message - The bot will say message.
• +ping - Tests ping time of the bot.
• +purge numMessages - [Currently disabled.] Deletes numMessages most recent messages from the current channel. numMessages must be between 2 and 100. Requires MANAGE_CHANNELS and MANAGE_MESSAGES permissions.

Automatic Actions

• Replaces GymHuntrBot's raid announcement with an enhanced announcement with a Google Maps URL of the gym location.
• Collects gym name to latitude/longitude mappings.
• (currently disabled) Listens for raid announcements by the GymHuntrBot and creates raid channels based on its posts if the pokemon is approved. Also makes a post with a Google Maps URL and map image of the gym location.
• (currently disabled) Deletes raid channels after the raid time has passed.
• (currently disabled) Deletes inactive raid channels (default inactivity time: 2 hours), checking periodically (default: every 5 minutes).

Add the bot to your Discord server

• If you already have a Discord server, you can authorize the Bot to run on your server here: https://goo.gl/ottg3W

Setup and Deploy

• Currently this runs on a local node.js server.

Pros and Cons of Automatic Channel Creation

Use of the automatic channel creation feature has some advantages:

• Raid discussions are isolated in single channels. Users can easily see the current status of coordinating a raid by reading the most recent few messages in a raid channel.
• In raid channels, users can easily see information about the Pokemon name, location (name, Google Maps URL, map image), and end time.
• Users can easily see which raids are active by looking at the channel list.

Use of this bot has some disadvantages:

• The bot relies heavily on GymHuntrBot working quickly and accurately (and not changing how they announce raids). Otherwise, users have to create raid channels manually.
• Creating raid channels manually requires knowing the command format.
• The bot may create a raid channel for a raid for which someone has already created a raid channel manually.
• The bot creates new channels which cannot be muted. Everyone would get notifications if they allow notifications.
• It's harder to coordinate people across nearby raid battles.
• Having lots of raid channels can lead to confusion, (but there would be similar confusion if all these raid discussions were in the same channel).

Some of the above disadvantages can be fixed if GymHuntrBot reports raids quickly and accurately.

TODO

• Implement +help.
• Add instructions for hosting locally
• Deploy in cloud and add instructions

Credits

This bot uses some code from the following (MIT-licensed code):

https://gist.github.com/eslachance/3349734a98d30011bb202f47342601d3

https://anidiots.guide/getting-started/your_basic_bot.html

https://github.com/praneetsharma/ClearMessagesBot-Discord