studybuffalo/meowth

A Discord helper bot for Pokemon Go communities.

Meowth

A Discord helper bot for Pokemon Go communities.

Meowth is a Discord bot written in Python 3.6 using version 1.0.0a of the discord.py library.

Meowth 2.0 is here! Now with Category Support!

Meowth is now able to handle being on multiple servers of any size in any part of the world and can be invited to your server without having to install Python or run anything on a local machine yourself. The configuration process is now handled completely on Discord via DM with the server owner. First, a list of current features:

1. User-driven (not automated) wild spawn and raid reporting.
2. Role management for each Pokemon species (Discord limits a server to 250 roles, however) that allows each user to opt-in only for the Pokemon they want. These roles are mentioned when spawns or raids are reported.
3. Raid reporting: Report either !raidegg, !raid or !exraid on the server to have meowth create channels to organise in. Certain commands can be used within raid channels, such as updating your stauts with !interested, !coming and !here. Users can easily determine the status of involved members with the !list command. Meowth also queries Google Maps to get a guess of the raid location (no access to the game means no list of gyms), or you can paste a maps link in the channel after creation to update it to exact coordinates.
4. Optional team management and new member welcome functions.

Directions for inviting a remotely hosted Meowth to your server:

Note: You must have manage_server permissions to invite.

1. Use THIS LINK to invite Meowth.
2. Select your server.
3. In your server, type !configure.
4. Meowth will DM you to setup your server. Be sure to read the prompts properly.
5. That's it! Enjoy!

You can join the Meowth server here for updates, setup help, feature requests, or just to test out the bot before you add it. https://discord.gg/hhVjAN8

If you want to tinker with Meowth yourself, you can still download this repo, make whatever changes you want (or keep everything if you want) and run Meowth locally. The configure process is the same except you'll have to use your own bot token.

Directions for installing and running the bot on your server:

1. Install Python 3.6 and ensure PIP is also installed with it. https://www.python.org/downloads/release/python-364/

2. Install the packages needed to run meowth by running install.py:

Linux:

python3 install.py

Windows:

py install.py

Tesseract-OCR has to be installed with a standard binary installer on Windows. Get the installer HERE

3. Make sure the Tesseract-OCR install folder and your python install folder are added to your system environment PATH variable.

4. Download the files in this repository. The main source code is in meowth/__main__.py and bot config is in config.json.

5. Go to https://discordapp.com/developers/applications/me#top and create a new app.

6. Name it and upload the avatar of your choice.

7. Create a bot user for your app and reveal the bot token to copy it.

8. Copy config_blank.json and rename to config.json.

9. Open config.json in a text editor (a good one to use is Notepad++) and paste the bot token into the value for "bot_token", replacing the "yourtoken" string.

10. Replace the "master" value in config.json with your user ID from discord.

11. Go back to your Discord application page and copy the Client ID.

12. Go to the following link, replacing <CLIENT_ID> with the Client ID you copied. https://discordapp.com/oauth2/authorize?client_id=<CLIENT_ID>&scope=bot&permissions=268822608

13. Select the server you want to add Meowth to and complete the prompts. If you get to an empty screen and didn't get to see the Google new reCaptcha tickbox, disable your adblocker. It is important to invite Meowth to your server before proceeding.

14. Make sure you have git installed and update your discord.py file to latest version using:

Linux:

python3 -m pip install -U git+https://github.com/Rapptz/discord.py@rewrite

Windows:

py -m pip install -U git+https://github.com/Rapptz/discord.py@rewrite

15. Install dependencies from the command prompt or terminal window:

Linux:

python3 install.py

Windows:

py install.py

16. Run the launcher from the command prompt or terminal window:

Linux:

python3 launcher.py -s

Windows:

py launcher.py -s

If successful, it should show "Meowth! That's right!".

17. The bot should have sent you DM in Discord. Add the team roles: mystic, instinct and valor. Ensure they're below the bot role in the server role hierarchy.

18. Simply type !configure in your server to start the configuration process.

Launcher Reference:

Arguments:

  --help, -h          Show the help message
  --start, -s         Starts Meowth
  --auto-restart, -r  Auto-Restarts Meowth in case of a crash.
  --debug, -d         Prevents output being sent to Discord DM, as restarting
                      could occur often.

Launch Meowth normally:

python3 launcher.py -s

Launch Meowth in debug mode if working on code changes:

python3 launcher.py -s -d

Launch Meowth with Auto-Restart:

python3 launcher.py -s -r

Directions for using Meowth:

Note: Avoid punctuation inside commands.

Arguments within < > are required.
Arguments within [ ] are optional.
pkmn = Pokemon

Admin or Manager Commands:

Commands	Requirements	Description
!save	Owner Only	Saves the save data to file.
!exit	Owner Only	Saves the save data to file and shutdown Meowth.
!restart	Owner Only	Saves the save data to file and restarts Meowth.
!announce [msg]	Owner Only	Sends announcement message to server owners.
!welcome [@member]	Owner Only	Sends the welcome message to either user or mentioned member.
!outputlog	Server Manager Only	Uploads the log file to hastebin and replies with the link.
!set prefix [prefix]	Server Manager Only	Sets Meowth's prefix.
!set regional <pkmn>	Server Manager Only	Sets server's regional raid boss. Accepts number or name.
!get prefix	Server Manager Only	Displays Meowth's prefix.
!get perms [channelid]	Server Manager Only	Displays Meowth's permissions in guild and channel.
!welcome [user]	Owner Only	Test welcome message on mentioned member
!configure	Server Manager Only	Configure Meowth
!reload_json	Owner Only	reloads JSON files for the server
!raid_json [level] [bosslist]	Owner Only	Edits or displays raid_info.json
!changeraid [level or boss]	Channel Manager Only	Changes raid boss or egg level
!clearstatus	Channel Manager Raid Channel	Cancel everyone's status.
!setstatus <user> <status> [count]	Channel Manager Raid Channel	Changes raid channel status lists.
!cleanroles	Channel Manager	Removes all 0 member pokemon roles.

Miscellaneous Commands

Commands	Requirements	Description
!help [command]	-	Shows bot/command help, with descriptions.
!about	-	Shows info about Meowth.
!uptime	-	Shows Meowth's uptime.
!team <team>	-	Let's users set their team role.

Pokemon Notification Commands:

Commands	Requirements	Description
!want <pkmn>	Want Channel	Adds a Pokemon to your notification roles.
!unwant <pkmn>	Want Channel	Removes a Pokemon from your notification roles.
!unwant all	Want Channel	Removes all Pokemon from your notification roles.

Reporting Commands:

Commands	Requirements	Description
!wild <pkmn> <location>	Region Channel	Reports a wild pokemon, notifying people who want it.
!raid <pkmn> <place> [timer]	Region Channel	Creates an open raid channel.
!raidegg <level> <place> [timer]	Region Channel	Creates a raid egg channel.
!raid <pkmn>	Raid Egg Channel	Converts raid egg to an open raid.
!raid assume <pkmn>	Raid Egg Channel	Assumes a pokemon on hatch.
!exraid <pkmn> <place>	Region Channel	Creates an exraid channel.
!invite	Region Channel	Gain entry to exraids.

Raid Channel Management:

Commands	Requirements	Description
!timer	Raid Channel	Shows the expiry time for the raid.
!timerset <timer>	Raid Channel	Set the expiry time for the raid.
!starttime [HH:MM AM/PM]	Raid Channel	Set a time for a group to start a raid.
!location	Raid Channel	Shows the raid location.
!location new <place/map>	Raid Channel	Sets the raid location.
!recover	Raid Channel	Recovers an unresponsive raid channel.
!duplicate	Raid Channel	Reports the raid as a duplicate channel.
!weather	Raid Channel	Sets the weather for the raid.
!counters	Raid Channel	Simulate a Raid battle with Pokebattler.
!archive	Raid Channel	Mark a channel for archiving.

Status Management:

Commands	Requirements	Description
!interested [number] [teamcounts] [boss list or all]	Raid Channel	Sets your status for the raid to 'interested'. Teamcounts format is m# v# i#. You can also supply a list of bosses or 'all' that you are interested in. Aliases: !i, !maybe
!coming [number] [teamcounts] [boss list or all]	Raid Channel	Sets your status for the raid to 'coming'. Teamcounts format is m# v# i#. You can also supply a list of bosses or 'all' that you are interested in. Aliases: !c
!here [number] [teamcounts] [boss list or all]	Raid Channel	Sets your status for the raid to 'here'. Teamcounts format is m# v# i#. You can also supply a list of bosses or 'all' that you are interested in. Aliases: !h
!lobby [number]	Raid Channel	Indicate you are entering the raid lobby. Aliases: !l
!starting	Raid Channel	Clears all members 'here', announce raid start.
!backout	Raid Channel	Request players in lobby to backout.
!cancel	Raid Channel	Cancel your status. Aliases: !x

List Commands:

Commands	Requirements	Description
!list	Region Channel	Lists all raids from that region channel. Aliases: !lists
!list	Raid Channel	Lists all member status' for the raid. Aliases: !lists
!list tags	Raid Channel	Same behavior as !list, but with @mentions.
!list interested	Raid Channel	Lists 'interested' members for the raid.
!list coming	Raid Channel	Lists 'coming' members for the raid.
!list here	Raid Channel	Lists 'here' members for the raid.
!list lobby	Raid Channel	List the number and users who are in the raid lobby.
!list teams	Raid Channel	Lists teams of the members that have RSVPd.
!list mystic	Raid Channel	Lists teams of mystic members that have RSVPd.
!list valor	Raid Channel	Lists teams of valor members that have RSVPd.
!list instinct	Raid Channel	Lists teams of instinct members that have RSVPd.
!list bosses	Raid Channel	Lists boss interest of members that have RSVPd.
!list wants	Want Channel	List the wants for the user.

General notes on Meowth:

Meowth relies completely on users for reports. Meowth was designed as an alternative to Discord bots that use scanners and other illegitimate sources of information about Pokemon Go. As a result, Meowth works only as well as the users who use it. As there are a lot of ways to interact with Meowth, there can be a bit of a rough learning period, but it quickly becomes worth it. Some commands are not necessary for normal usage and are only there for advanced users.

If you are having trouble getting Meowth running in your server, we have found that the majority of problems are either from permissions or your configuration. Check permissions with !get perms and check your configuration with !configure before asking for help in the support server.

Known issues:

Compatibility with Python 3.6 on Mac OS X requires running "Install Certificates.command" in the Python 3.6 folder.