6-lasers / 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.5 using version 0.16.8 of the discord.py library.

Directions for installing and running the bot on your server:

1. Install Python 3.5 for whatever OS you have on your home computer. https://www.python.org/downloads/release/python-350/

2. Install discord.py. To do this, run this command in your command prompt: python3 -m pip install -U discord.py (On Windows: py -m pip install -U discord.py should work)

3. Download the files in this repository. The source code is in meowth.py, the rest of the files are images for the custom emoji that Meowth uses.

4. Go here https://discordapp.com/developers/applications/me#top and create a new app. Name it Meowth if you like and upload the Meowth avatar included in the repository. Create a bot user for your app.

5. Copy this link. https://discordapp.com/oauth2/authorize?client_id=<CLIENT_ID>&scope=bot Paste it into your browser. Then go to your Discord application page again and copy the client id, inserting it into the above link where it says <CLIENT_ID>. Press enter and select the server you want to add Meowth too.

6. Give Meowth admin privileges.

7. Go back to your app page in Discord and click to reveal the bot token, then copy it. Open config.py in a text editor. Paste the bot token into line 18, replacing the "mytokenhere" string.

8. Run meowth.py from the command prompt or terminal window. If successful, it should print "Meowth! That's right!" to the window and the bot should show up as online in Discord.

9. All commands except !team should be working. The welcome message may or may not be working at this point. Google Maps links may not be that accurate yet. The raid commands will be using default values like :omw: which may not be configured on your server.

Configure Meowth

1. Open config.py in a text editor. You'll need to make a few easy edits.

2. Enable the !team command. If you haven't already, create a role for each team. Enter the role names in the team_dict on line 58. The team emoji are configured on this line as well (see step 5 and 6).

3. Enable the welcome message. On lines 26, 30, and 34, configure the names of your server's @admin role, default channel, and #announcements/#welcome channel.

4. Enable Google Maps hints. In lines 38 and 39, replace "yourtown" and "yourstate" with your community's location. This makes the Google Maps location links work a lot better.

5. Upload emoji to server (optional). If you're going to use the included emoji, upload the images in the folder as custom emoji for your server. There are 18 type icons, an omw emoji (car), an unomw emoji (car with a circle and a line through it), and here and unhere emoji (Go Plus), and an emoji for each of the three teams.

6. Configure raid command strings. Using the variables in lines 61-85, customize the emoji messages to match the ones on your server. Meowth will attempt to look up the names in your server's emoji list. You'll have to do this for each of the 25 custom emoji. You can also just use plain strings if your emoji slots are already taken or if you just prefer it that way.

7. Save config.py. Next time you run Meowth, the changes will take effect.

Directions for using Meowth:

Note: avoid punctuation of any kind inside commands. The <> in these instructions are there for decoration

1. !team - adds you to a team role on the server. These roles must be created beforehand.

2. !want - adds you to an invisible role for a Pokemon. Meowth will create a role if none exists.

3. !wild - Meowth will send a message @mentioning and including a Google Maps link to . If is blank, Meowth will ask for more details.

4. !raid - Does the same thing as !wild, but also creates a new channel by the name of #-. The message also includes the custom emoji for the types that do super effective damage against the Pokemon. The created raid channel will automatically delete in two hours.

5. :omw:/:here: - in a raid channel, the custom emoji for omw and here tell Meowth that you are on your way to or at a raid. If you have multiple trainers with you, type another emoji for each additional trainer. Typing :here: also removes you from the on the way list. The exact phrases are configurable on lines 53-56.

6. :unomw:/:unhere: - in a raid channel, these custom emoji tell Meowth to remove you from the on the way or waiting lists. The exact phrases are configurable on lines 53-56.

7. !otw/!waiting - in a raid channel, these commands tell Meowth to list and mention the trainers who said they were on the way or at a raid. It also includes the total number.

8. !starting - in a raid channel, this command tells Meowth to delete the !waiting list for that raid. Meowth will mention the users and ask them to respond with :here: if they are still waiting.

9. !timerset H:MM - in a raid channel, this tells Meowth how long is remaining on the raid. Meowth will send a message notifying the time at which the raid will end. Also overwrites any previously used !timerset command for that raid.

10. !timer - in a raid channel, tells Meowth to resend the message from the last !timerset command. Prevents unnecessary scrolling.

General notes on Meowth:

Meowth relies completely on user reports of raids, wild spawns, on the way to a raid, at a raid, and starting a raid. 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 10+ ways of interacting with Meowth, there can be a bit of a rough learning period, but it quickly becomes worth it.

Known issues:

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