PokeResearchAdminBot Manual
The PokeResearchAdminBot provides a way to administer a groups of field research tasks and share them with your local Pokémon GO community.
The related PokeResearchPublishBot can publish tasks reported by your community members to designated Telegram channels.
In addition, the bot also provides a Google Map with markers for each task reported by your community.
Users can filter tasks they are interested in.
The following commands can be used with the PokeResearchAdminBot:
-
/area — Manages geographic areas for publishing tasks to Telegram.
- center — Updates the center of an area.
- delete — Deletes an existing area.
- details — Prints the details of an area.
- list — Prints a list of all areas.
- new — Creates a new area.
- radius — Updates the distance/radius of an area.
- /communityname — Sets the name of your community.
- /delete — Deletes a field research task.
- /export — Prints the secret administrator key for this community.
-
/group — Manages groups of tasks based on their rewards.
- add — Adds an item or Pokémon to a group of tasks.
- delete — Deletes an existing group of tasks.
- details — Prints the details of a task group.
- list — Prints a list of all task groups.
- new — Creates a new group of tasks.
- remove — Removes an item or Pokémon from a group of tasks.
- /import — Connects to a different community.
- /language — Sets the language of your community.
- /links — Prints a list of links for your community to use.
- /pokemon — Specifies a Pokémon that was found from a PokéStop.
- /publish — Publishes tasks to a Telegram group/channel.
- /readkey — Prints a key that allows a PokeResearch bot to connect to this group.
- /setmapcenter — Sets the center of your community's map.
- /setmapzoom — Sets the zoom level of your community's map.
- /subscriptions — Lists the groups/areas published to Telegram.
- /unpublish — Unpublishes tasks from a Telegram group/channel.
The "center" subcommand moves the geographic center of an area.
The size of the area remains the same.
The parameters are:
Area Name
The name of the area to be updated. If not specified, and more than one area exists, then the bot will prompt you to select one.
Location
The location must be specified as latitude and longitude. For example: 12.234,5.678. The comma in between the coordinates is optional. Also, surrounding parenthesis are optional to support copying and pasting from certain Google Maps platforms.
Setting the Center
/area center 38.0065,-122.1066
Your area 'Smallville' is now centered at: 38.0065,-122.1066
To delete an area, use the "delete" subcommand.
You don't have to type the exact name of the area to be deleted.
The research bot just needs enough information to uniquely identify the area to be deleted.
Before deleting the area, the research bot will prompt you to confirm the deletion.
Delete Area
/area delete small
Are you sure you want to delete area Smallville?
🗑 DELETE IT
❌ Cancel
To see the full details for an area, use the "details" subcommand.
To see a list of all areas, use the
/area list command.
Area Details
/area details smallville
Name: Smallville
Radius: 2.5 miles
# Subscriptions: 1
The center is located here:
To see a list of all areas that have been created, use the "list" subcommand.
If you would like to see the full details for a single area, use the
/area details command.
Area List
/area list
Metropolis
Smallville
Every Pokémon GO community can create one or more geographic areas.
Before tasks can be published to a Telegram group or channel, an area must be specified to indicate where the tasks are located.
Area management is done with the /area command.
Use the "new" subcommand to create a new area.
The parameters are:
Area Name
The name of the area. All areas must have unique names in your community.
Center
The center of the area must be specified as latitude and longitude. For example: 12.234,5.678. If location is not specified, then the bot will prompt you to select a location from a map.
Create Area
/area new Smallville
What is the center of the area?
Send my Current Location
/cancel
Your area 'Smallville' has been created.
The default radius is 5 miles.
Use the /area radius command to change the radius.
For example:
Change an Area's radius
/area radius distance
Example: /area radius 3 miles
Example: /area radius 5 km
The "radius" subcommand changes the size of an area.
The parameters are:
Area Name
The name of the area to be updated. If not specified, and more than one area exists, then the bot will prompt you to select one.
Distance
The size of the area from the center to the edge. The size can be specified in miles or kilometers. Some examples: "5 miles", "10 km", "1000 meters", etc.
Setting the Radius
/area radius 2.5 miles
Your area 'Smallville' now has a radius of 2.5 miles.
The /communityname command sets the name of your local Pokémon GO community.
Using this command is optional, but recommended.
Other users who report tasks with the Research Bot will see this community name.
When they see a community name that they recognize, they will feel more comfortable knowing they are connecting to the right community.
Set Community Name
/communityname Diablo Valley Pokémon GO
The name of your community is now 'Diablo Valley Pokémon GO'.
To see your current community name, use the /communityname command without any parameters.
Get Community Name
/communityname
The name of your community is 'Diablo Valley Pokémon GO'.
/deletetask
The /delete command permanently deletes a task.
The task must have been reported on the same day (otherwise it would have been archived).
Also, the task must have been reported by someone in your community.
The single parameter of the /delete command is a unique task ID.
You can find IDs of your community tasks on the admin map (find a link to the admin map with the
/links command.)
Once the task is deleted, it is removed from the field research map.
Delete a Task
/delete gym-win-aa30f234
Are you sure you want to delete the following task?
Task: Win a Gym battle
Reward: Bulbasaur, Charmander, or Squirtle
🗑 DELETE IT
❌ Cancel
The result of the /export command is a unique key for your group.
This key can be used to restore a lost connection to your research list, or to migrate PokeResearchAdminBot to a different chat.
The export key is essentially a password, so be sure to keep it secret and in a safe location.
Do not share this value with other members of your community.
Also, because everyone in the chat with PokeResearchAdminBot can invoke /export, be sure you trust all the members in the chat.
Export Key
/export
694c0f20-5587-4de6-9e2a-8a961db4a924
Task groups separate certain tasks from the entire list of tasks.
The way these tasks are differentiated are by their rewards.
For example, a task group can be created that contains all tasks that reward Rare Candy, Larvitar, or any combination of rewards.
Using the "add" subcommand to add a reward item to a task group:
Add Item
/group add rare candy
'Important Tasks' will now publish tasks that reward Rare Candy.
By default, all tasks with the given reward are assigned to the task group regardless of quantity.
However, you can also indicate the minimum number of rewards that a task must have in order to be assigned to the task group.
Add Item with Minimum Amount
/group add 3 rare candy
'Important Tasks' will now publish tasks that reward 3 or more Rare Candy.
Using the "add" subcommand to add a specific Pokémon Encounter to a task group:
Add Pokémon
/group add larvitar
'Important Tasks' will now publish tasks that reward encounters with Larvitar.
If you want to assign all Pokémon Encounters, regardless of the type of Pokémon, to the task group, use the "add" command with "pokemon" as the parameter instead.
To delete a task group, use the "delete" subcommand.
You don't have to type the exact name of the group to be deleted.
The research bot just needs enough information to uniquely identify the group to be deleted.
Before deleting the group, the research bot will prompt you to confirm the deletion.
Delete Group
/group delete pikachu tasks
Are you sure you want to delete group Special Event Pikachu Tasks?
🗑 DELETE IT
❌ Cancel
To see the full details for a single task group, use the "details" subcommand.
This will include all the rewards and Pokémon added with the
/group add command.
To see a list of all task groups, use the
/group list command.
Group Details
/group details important tasks
Name: Important Tasks
# Subscriptions: 1
Rewards: Charged TMs and 3 or more Rare Candy
Pokémon: Chansey, Dratini, Larvitar, and Lickitung
To see a list of all task groups that have been created, use the "list" subcommand.
If you would like to see the full details for a single task group, use the
/group details command.
Group List
/group list
Important Tasks
Special Event Tasks
Every Pokémon GO community can create one or more task groups.
Each group can be configured with different types of tasks and those tasks can be published to specific Telegram channels when a member reports them.
The groups can also be used as filters on your community research map.
Group management is done with the /group command. Use the "new" subcommand to create a new group.
Create Group
/group new Important Tasks
Your group 'Important Tasks' has been created.
You can publish tasks in this group by
adding the Research Publish Bot to a Telegram group/channel and then using the
/publish command. (For Telegram groups/supergroups use the
/publish command in the target group. For Telegram channels use the
/publish comand here.)
Use the "
/group add" command to register which rewards and/or Pokémon you would like to include in this group.
For example:
Add a Reward/Pokémon to a Group
/group add Reward Type
Example: /group add Rare Candy
Example: /group add Snorlax
Using the "remove" subcommand to remove a specific reward item from a group:
Remove Item
/group remove rare candy
'Important Tasks' will no longer publish tasks that reward Rare Candy.
Using the "remove" subcommand to remove a specific Pokémon from a group:
Remove Pokémon
/group remove larvitar
'Important Tasks' will no longer publish tasks that reward encounters with Larvitar.
The /import command takes an export key and moves administrative capabilities from an old chat to the current chat.
There are several scenarios for wanting to do this.
First, you may be in the process of reorganizing your Telegram groups, and you want to move PokeResearchAdminBot, and all its capabilities, to a new group.
The first step of this process is to run
/export in the old Telegram group.
(You did this anyway because the tutorial said to do it as one of the first steps in setting up the PokeResearchAdminBot, right?!)
Then, go to the new Telegram group, add PokeResearchAdminBot to the group, and run the /import command with the export key.
Migrate Telegram groups
/import 0a6c1148-6c85-46c2-8ec8-c282fa0b1009
Your list for Diablo Valley Pokémon GO was succesfully migrated.
The second scenario is when you've somehow lost access to PokeResearchAdminBot's Telegram group.
Perhaps someone accidentally deleted your Telegram group.
The steps for recovery are exactly the same as the first scenario because you remembered to backup the export key, right?
(You should be getting the hint to backup the export key by now.)
Recover Research List
/import 0a6c1148-6c85-46c2-8ec8-c282fa0b1009
Your list for Diablo Valley Pokémon GO was succesfully migrated.
The third scenario is when you just need to change the export key.
This could happen because perhaps a member was kicked out of the admin group and you want to make sure they don't have the export key.
To change the key, simply execute the /import command in the same Telegram Group.
Remember to make note of the new export key, and of course, back it up in a secret, secure place.
Change Export Key
/export
7ecb0cef-8155-4c6b-86a3-a13782f62ae3
/import 7ecb0cef-8155-4c6b-86a3-a13782f62ae3
Your export key has been changed.
/export
de22205a-f52b-4107-9d2e-7bd031683515
The Research Bot supports multiple languages besides English.
To change the bot's language, use the /language command.
You can either use your native language name (e.g. "Deutsch") or the English name of the language (e.g. "German").
Set Language
/language Português
Your community's language is now Português.
To see your current language, use the /language command with no parameters.
Get Language
/language
Your community's language is Português.
The /links command prints a list of useful links that you can use inside or outside of Telegram.
You can choose to provide these links to your community to interact with the various PokeResearch bots.
In the following example, MYREADKEY will automatically be replaced with your
/readkey.
Some tasks can reward more than one type of Pokémon.
Fortunately, everyone who receives a task from the same PokéStop will receive the exact same Pokémon.
To specify which Pokémon was received from a specific PokéStop, use the /pokemon command.
The single parameter of the /pokemon command is a unique task ID.
You can find IDs of your community tasks on the admin map (find a link to the admin map with the
/links command.)
Set Pokémon
/pokemon power-x5-da50fa35
Select the Pokémon that you received from the task:
Bulbasaur
Charmander
Squirtle
❓ Unknown
❌ Cancel
When a task is reported, the research bot has the capability of identifying nearby communities and posting those tasks to Telegram groups and/or channels.
The /publish command is how you tell the research bot which tasks to publish to which Telegram groups/channels.
Some important definitions:
A Telegram group (or supergroup) allows users to join and post messages to it.
A Telegram channel allows users to subscribe to it, but messages can only be posted by channel administrators.
To publish tasks to a Telegram group (or supergroup), a group administrator must execute the /publish command in the same Telegram group.
However, because of the nature of Telegram channels, to publish to a Telegram channel, you must execute the /publish command in the research bot admin group.
If you have more than one group or area, you will be prompted to choose one of each.
Publish to a Channel
/publish
What channel will these tasks be published to?
Forward an existing message from the channel to here.
Both you and PokeResearchPublishBot must already be administrators of the channel.
Forwarded from Research Tracker
This channel is for sharing tasks.
Group: Important Tasks
Area: Smallville
Channel: Research Tracker
Subscription ID: d492ba91-85c9-46e9-b3a4-10c2fc3cc407
The above tasks will now be published.
The result of the /readkey command is a unique key for your group.
At first glance this seems really similar to the results of the
/export key.
But there are a few differences:
First, while the export key is secret, the read key can be shared publicly.
No need to keep it secret.
Second, the export key is used by the
/import command, but the read key is used by PokeResearchBot's /readkey command.
And finally, the export key can only be imported once, but the read key can be imported an unlimited number of times.
This is an important distinction.
It means that only one Telegram group can administer your community.
However many Telegram users can report tasks for your community.
Read Key
/readkey
180e6b40-5c73-445d-9190-8d059f2bf4f9
Most times, you won't need to use the read key explicitly.
In the
/links message both links contain the read key as a URL parameter.
It is far easier to use the
/links command than constructing your own URLs manually.
Changes the default location of your community's research map.
This is the location that the map opens to when first opening the map in your browser.
The location must be specified as latitude and longitude.
For example: 12.234,5.678.
The comma in between the coordinates is optional.
Also, surrounding parenthesis are optional to support copying and pasting from certain Google Maps platforms.
Set Map Center
/setmapcenter 37.767,-122.450
The map center is now set to 37.767,-122.450.
Changes the default zoom level of your community's research map.
Zoom levels control how big of an area Google Maps displays in your browser.
The default zoom level is 13.
Higher numbers zoom closer in to cities and even city blocks.
Lower numbers zoom further out to regions and even countries.
Set Map Zoom
/setmapzoom 12
The map zoom level is now set to 12.
Use the /subscriptions command to see a list of all subscriptions created with the
/publish command.
List Subscriptions
/subscriptions
Group: Important Tasks
Area: Smallville
Channel: Research Tracker
Subscription ID: d492ba91-85c9-46e9-b3a4-10c2fc3cc407
Group: Important Tasks
Area: Metropolis
Channel: Research Tracker
Subscription ID: 8d1d9f8e-ed24-421b-95f2-aa5a2c25a743
Message this bot to report new tasks.
Google Maps for regular users.
Google Maps for administrators.
Use the /unpublish command to remove a subscription created previously by the
/publish command.
The single parameter is the Subscription ID that was generated when the subscription was created.
To identify an exisiting subscription ID, use the
/subscriptions command.
Unpublish
/unpublish d492ba91-85c9-46e9-b3a4-10c2fc3cc407
Group: Important Tasks
Area: Smallville
Channel: Research Tracker
The subscription has been removed.