Skip to content

Get Discord notifications for all Shinies your MAD's finding

Notifications You must be signed in to change notification settings

ColdShadow80/shinywatcher

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

MAD Plugin - Shiny Watcher

Get support on this Discord Server

Shiny watcher plugin is not a standalone feature and is not something to put in your phone. It is a feature from a very complex system that you have to understand. If you don't understand the Wiki and how to make your own map, you don't have any way to use it yourself.

Shiny Watcher checks your DB for active Shinies and then sends a notification to Discord if it finds any. It allows you to filter out Pokemon and Workers as well as connect a Login E-Mail to every worker.

Notifications are in the format: Pokemon-name IV% Level# CP# Gender:symbol; Despawns: Time (time left); Worker name (account/email or PTC). On Android devices, the coordinates are embeded so you can copy them by long-pressing (for ~2 seconds). Fast and easy. There's also an option to optimize what is displayed for iOS.

Screenshot

Notes

  • MAD and Discord only
  • only works with MAD plugin system
  • a discord_webhook must be configured in the MAD enviroment to receive notifications
  • Possible to send different webhook locations based on the device (mixed mode)
  • discord.py has to be installed in the MAD environment to enable CatchHelper (https://github.com/Rapptz/discord.py)
  • a deparate Discord Bot is required to use CatchHelper
  • game_stats_raw must be enabled within your MAD config
  • Pingusermapping and CatchHelper are optional
  • Credits to CCEV who created the original version of shinywatcher
  • Special Credits to crhbetz who made CatchHelper run in the plugin system

Getting Started

  • import Plugin ShinyWatcher.mp via MADmin website at System > MAD Plugins
  • install requirements.txt to your MAD python env
  • cp plugin.ini.example plugin.ini
  • Fill out plugin.ini (it's explained below what to fill in)
  • restart MAD to activate the plugin configuration

What to fill in

Config

copy plugin.ini.example to plugin.ini and adjust it with your data

  • ONLY_SHOW_WORKERS Leave blank if you want notifications from all workers. If you only want them from certain Accounts, follow the format in the example
  • EXCLUDE_MONS Filter out Mons you already have enough Shinies of. Follow the example format!
  • OS Set your notifications to android or ios mode. On Android, messages have an embed contaning the coords. For iOS an extra message containing coords will be sent

Pingusermapping

Ping one or more users in Discord when the mapped Scanner encounters a shiny. To get your User ID or anyone else’s User ID right click on their name and click “Copy ID” Alternative type there name as a mention and place a backslash \ in front of the mention.

CatchHelper

CatchHelper will add 3 buttons to discord notifications. By clicking the buttons, you can pause, start or stop your device to be able to login to your account with your phone. If you click the pause button the device will stop and pause for 5min before re-starting.

plugin.ini

[plugin]
active = true
discord_webhookurl: https://discord.com/api/webhooks/xxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx
language = en
os = android
timeformat = 24
mindespawntime = 1
maxdespawntime = 120
only_show_workers = ATV01,ATV19,ATV34
exlude_mons = 1,7,36
mask_mail = no
pinguser = no
timezone_offset = 0
accounts_usernames = privatePTC1,privateGmail1@gmail.com
accounts_display_custom = Instead_of_privatePTC1,Instead_of_privateGmail1@gmail.com

[catchhelper]
activate_catchhelper = yes
bot_token = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
madmin_url = http://required
madmin_user = madmin username
madmin_pass = madmin password
pause_time = 2
play_button = true
pause_button = true
stop_button = true

[pingusermapping]
device_origin = @xxxxxxxxxxxxxxxxxxxxxxxx

About

Get Discord notifications for all Shinies your MAD's finding

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 89.1%
  • HTML 10.4%
  • JetBrains MPS 0.5%