aboutsummaryrefslogtreecommitdiffstats
path: root/bot/cogs
diff options
context:
space:
mode:
Diffstat (limited to 'bot/cogs')
-rw-r--r--bot/cogs/candy_collection.py69
-rw-r--r--bot/cogs/hacktoberstats.py9
-rw-r--r--bot/cogs/halloweenify.py48
-rw-r--r--bot/cogs/movie.py136
-rw-r--r--bot/cogs/spookyreact.py31
-rw-r--r--bot/cogs/template.py5
6 files changed, 276 insertions, 22 deletions
diff --git a/bot/cogs/candy_collection.py b/bot/cogs/candy_collection.py
index 1d470524..63ce9cb6 100644
--- a/bot/cogs/candy_collection.py
+++ b/bot/cogs/candy_collection.py
@@ -5,7 +5,7 @@ import json
import functools
import os
-json_location = os.path.join(os.getcwd(),'resources', 'candy_collection.json')
+json_location = os.path.join(os.getcwd(), 'resources', 'candy_collection.json')
class CandyCollection:
@@ -19,7 +19,7 @@ class CandyCollection:
userid = userinfo['userid']
self.get_candyinfo[userid] = userinfo
- HACKTOBER_CHANNEL_ID = 496432022961520650
+ HACKTOBER_CHANNEL_ID = 498804484324196362
# chance is 1 in x range, so 1 in 20 range would give 5% chance (for add candy)
ADD_CANDY_REACTION_CHANCE = 20 # 5%
ADD_CANDY_EXISTING_REACTION_CHANCE = 10 # 10%
@@ -27,36 +27,44 @@ class CandyCollection:
ADD_SKULL_EXISTING_REACTION_CHANCE = 20 # 5%
async def on_message(self, message):
- """Make sure the user is not a bot and
- the channel is #event-hacktoberfest.
- Because the skull has a lower chance of occurring
- we'll check for that first, and then add respective reactions"""
+ """Randomly adds candy or skull to certain messages"""
+
+ # make sure its a human message
if message.author.bot:
return
+ # ensure it's hacktober channel
if message.channel.id != self.HACKTOBER_CHANNEL_ID:
return
+
+ # do random check for skull first as it has the lower chance
if random.randint(1, self.ADD_SKULL_REACTION_CHANCE) == 1:
d = {"reaction": '\N{SKULL}', "msg_id": message.id, "won": False}
self.msg_reacted.append(d)
return await message.add_reaction('\N{SKULL}')
+ # check for the candy chance next
if random.randint(1, self.ADD_CANDY_REACTION_CHANCE) == 1:
d = {"reaction": '\N{CANDY}', "msg_id": message.id, "won": False}
self.msg_reacted.append(d)
return await message.add_reaction('\N{CANDY}')
async def on_reaction_add(self, reaction, user):
- """Make sure the reaction is in #event-hacktoberfest
- and the user reacting is not a bot (ie. ourselves)
- Check if the reaction is a skull/candy first. """
+ """Add/remove candies from a person if the reaction satisfies criteria"""
+
message = reaction.message
- if message.channel.id != self.HACKTOBER_CHANNEL_ID:
- return
+ # check to ensure the reactor is human
if user.bot:
return
+ # check to ensure it is in correct channel
+ if message.channel.id != self.HACKTOBER_CHANNEL_ID:
+ return
+
+ # if its not a candy or skull, and it is one of 10 most recent messages,
+ # proceed to add a skull/candy with higher chance
if str(reaction.emoji) not in ('\N{SKULL}', '\N{CANDY}'):
if message.id in await self.ten_recent_msg():
await self.reacted_msg_chance(message)
return
+
for react in self.msg_reacted:
# check to see if the message id of a message we added a
# reaction to is in json file, and if nobody has won/claimed it yet
@@ -78,7 +86,7 @@ class CandyCollection:
await self.send_spook_msg(message.author, message.channel, lost)
except KeyError:
- # otherwise it will raise KeyError so we need to add them
+ # otherwise it will raise KeyError so we need to add them to file
if str(reaction.emoji) == '\N{CANDY}':
print('ok')
d = {"userid": user.id, "record": 1}
@@ -86,8 +94,9 @@ class CandyCollection:
await self.remove_reactions(reaction)
async def reacted_msg_chance(self, message):
- """(Randomly) add a skull or candy to a message if there is a reaction there already
+ """Randomly add a skull or candy to a message if there is a reaction there already
(higher probability)"""
+
if random.randint(1, self.ADD_SKULL_EXISTING_REACTION_CHANCE) == 1:
d = {"reaction": '\N{SKULL}', "msg_id": message.id, "won": False}
self.msg_reacted.append(d)
@@ -101,58 +110,75 @@ class CandyCollection:
async def ten_recent_msg(self):
"""Get the last 10 messages sent in the channel"""
ten_recent = []
- recent_msg = max((x for x in self.bot._connection._messages
- if x.channel.id == self.HACKTOBER_CHANNEL_ID), key=lambda x: x.id)
+ recent_msg = max(message.id for message
+ in self.bot._connection._messages
+ if message.channel.id == self.HACKTOBER_CHANNEL_ID)
+
channel = await self.hacktober_channel()
ten_recent.append(recent_msg.id)
+
for i in range(9):
o = discord.Object(id=recent_msg.id + i)
msg = await channel.history(limit=1, before=o).next()
ten_recent.append(msg.id)
+
return ten_recent
async def get_message(self, msg_id):
- """Get the message from it's ID. Use history rather than get_message due to
- poor ratelimit (50/1s vs 1/1s)"""
+ """Get the message from it's ID."""
+
try:
o = discord.Object(id=msg_id + 1)
+ # Use history rather than get_message due to
+ # poor ratelimit (50/1s vs 1/1s)
msg = await self.hacktober_channel.history(limit=1, before=o).next()
+
if msg.id != msg_id:
return None
+
return msg
+
except Exception:
return None
async def hacktober_channel(self):
- """Get #events-hacktober channel from it's id"""
+ """Get #hacktoberbot channel from it's id"""
return self.bot.get_channel(id=self.HACKTOBER_CHANNEL_ID)
async def remove_reactions(self, reaction):
"""Remove all candy/skull reactions"""
+
try:
async for user in reaction.users():
await reaction.message.remove_reaction(reaction.emoji, user)
+
except discord.HTTPException:
pass
async def send_spook_msg(self, author, channel, candies):
+<<<<<<< HEAD
+ """Send a spooky message"""
+=======
"""Send a (lame) spooky message"""
+>>>>>>> 4c29c2b470d6f27416a97c3be1e41f753e0a1ea6
e = discord.Embed(colour=author.colour)
e.set_author(name="Ghosts and Ghouls and Jack o' lanterns at night; "
f"I took {candies} candies and quickly took flight.")
await channel.send(embed=e)
def save_to_json(self):
- """Save json to the file. We will do this with bad practice
- async (run_in_executor) to prevent blocking"""
+ """Save json to the file."""
with open(json_location, 'w') as outfile:
json.dump(self.candy_json, outfile)
@commands.command()
async def candy(self, ctx):
"""Get the candy leaderboard and save to json when this is called"""
+
+ # use run_in_executor to prevent blocking
thing = functools.partial(self.save_to_json)
save = await self.bot.loop.run_in_executor(None, thing)
+
emoji = (
'\N{FIRST PLACE MEDAL}',
'\N{SECOND PLACE MEDAL}',
@@ -160,8 +186,10 @@ class CandyCollection:
'\N{SPORTS MEDAL}',
'\N{SPORTS MEDAL}'
)
+
top_sorted = sorted(self.candy_json['records'], key=lambda k: k.get('record', 0), reverse=True)
top_five = top_sorted[:5]
+
usersid = []
records = []
for record in top_five:
@@ -170,6 +198,7 @@ class CandyCollection:
value = '\n'.join(f'{emoji[index]} <@{usersid[index]}>: {records[index]}'
for index in range(0, len(usersid))) or 'No Candies'
+
e = discord.Embed(colour=discord.Colour.blurple())
e.add_field(name="Top Candy Records", value=value, inline=False)
e.add_field(name='\u200b',
diff --git a/bot/cogs/hacktoberstats.py b/bot/cogs/hacktoberstats.py
index 4e896ae9..ac81b887 100644
--- a/bot/cogs/hacktoberstats.py
+++ b/bot/cogs/hacktoberstats.py
@@ -95,7 +95,14 @@ class Stats:
is_query = f"public+author:{username}"
date_range = "2018-10-01..2018-10-31"
per_page = "300"
- query_url = f"{base_url}-label:{not_label}+type:{action_type}+is:{is_query}+created:{date_range}&per_page={per_page}"
+ query_url = (
+ f"{base_url}"
+ f"-label:{not_label}"
+ f"+type:{action_type}"
+ f"+is:{is_query}"
+ f"+created:{date_range}"
+ f"&per_page={per_page}"
+ )
headers = {"user-agent": "Discord Python Hactoberbot"}
async with aiohttp.ClientSession() as session:
diff --git a/bot/cogs/halloweenify.py b/bot/cogs/halloweenify.py
new file mode 100644
index 00000000..a5fe45ef
--- /dev/null
+++ b/bot/cogs/halloweenify.py
@@ -0,0 +1,48 @@
+from json import load
+from pathlib import Path
+from random import choice
+
+import discord
+from discord.ext import commands
+from discord.ext.commands.cooldowns import BucketType
+
+
+class Halloweenify:
+ """
+ A cog to change a invokers nickname to a spooky one!
+ """
+
+ def __init__(self, bot):
+ self.bot = bot
+
+ @commands.cooldown(1, 300, BucketType.user)
+ @commands.command()
+ async def halloweenify(self, ctx):
+ """
+ Change your nickname into a much spookier one!
+ """
+ with open(Path('./bot/resources', 'halloweenify.json'), 'r') as f:
+ data = load(f)
+
+ # Choose a random character from our list we loaded above and set apart the nickname and image url.
+ character = choice(data['characters'])
+ nickname = ''.join([nickname for nickname in character])
+ image = ''.join([character[nickname] for nickname in character])
+
+ # Build up a Embed
+ embed = discord.Embed()
+ embed.colour = discord.Colour.dark_orange()
+ embed.title = 'Not spooky enough?'
+ embed.description = (
+ f'**{ctx.author.display_name}** wasn\'t spooky enough for you? That\'s understandable, '
+ f'{ctx.author.display_name} isn\'t scary at all! Let me think of something better. Hmm... I got it!\n\n '
+ f'Your new nickname will be: \n :ghost: **{nickname}** :jack_o_lantern:'
+ )
+ embed.set_image(url=image)
+
+ await ctx.author.edit(nick=nickname)
+ await ctx.send(embed=embed)
+
+
+def setup(bot):
+ bot.add_cog(Halloweenify(bot))
diff --git a/bot/cogs/movie.py b/bot/cogs/movie.py
new file mode 100644
index 00000000..925f813f
--- /dev/null
+++ b/bot/cogs/movie.py
@@ -0,0 +1,136 @@
+import random
+from os import environ
+
+import aiohttp
+from discord import Embed
+from discord.ext import commands
+
+
+TMDB_API_KEY = environ.get('TMDB_API_KEY')
+TMDB_TOKEN = environ.get('TMDB_TOKEN')
+
+
+class Movie:
+ """
+ Selects a random scary movie and embeds info into discord chat
+ """
+
+ def __init__(self, bot):
+ self.bot = bot
+
+ @commands.command(name='movie', alias=['tmdb'])
+ async def random_movie(self, ctx):
+ """
+ Randomly select a scary movie and display information about it.
+ """
+ selection = await self.select_movie()
+ movie_details = await self.format_metadata(selection)
+
+ await ctx.send(embed=movie_details)
+
+ @staticmethod
+ async def select_movie():
+ """
+ Selects a random movie and returns a json of movie details from TMDb
+ """
+
+ url = 'https://api.themoviedb.org/4/discover/movie'
+ params = {
+ 'with_genres': '27',
+ 'vote_count.gte': '5'
+ }
+ headers = {
+ 'Authorization': 'Bearer ' + TMDB_TOKEN,
+ 'Content-Type': 'application/json;charset=utf-8'
+ }
+
+ # Get total page count of horror movies
+ async with aiohttp.ClientSession() as session:
+ response = await session.get(url=url, params=params, headers=headers)
+ total_pages = await response.json()
+ total_pages = total_pages.get('total_pages')
+
+ # Get movie details from one random result on a random page
+ params['page'] = random.randint(1, total_pages)
+ response = await session.get(url=url, params=params, headers=headers)
+ response = await response.json()
+ selection_id = random.choice(response.get('results')).get('id')
+
+ # Get full details and credits
+ selection = await session.get(
+ url='https://api.themoviedb.org/3/movie/' + str(selection_id),
+ params={'api_key': TMDB_API_KEY, 'append_to_response': 'credits'}
+ )
+
+ return await selection.json()
+
+ @staticmethod
+ async def format_metadata(movie):
+ """
+ Formats raw TMDb data to be embedded in discord chat
+ """
+
+ # Build the relevant URLs.
+ movie_id = movie.get("id")
+ poster_path = movie.get("poster_path")
+ tmdb_url = f'https://www.themoviedb.org/movie/{movie_id}' if movie_id else None
+ poster = f'https://image.tmdb.org/t/p/original{poster_path}' if poster_path else None
+
+ # Get cast names
+ cast = []
+ for actor in movie.get('credits', {}).get('cast', [])[:3]:
+ cast.append(actor.get('name'))
+
+ # Get director name
+ director = movie.get('credits', {}).get('crew', [])
+ if director:
+ director = director[0].get('name')
+
+ # Determine the spookiness rating
+ rating = ''
+ rating_count = movie.get('vote_average', 0)
+
+ if rating_count:
+ rating_count /= 2
+
+ for _ in range(int(rating_count)):
+ rating += ':skull:'
+ if (rating_count % 1) >= .5:
+ rating += ':bat:'
+
+ # Try to get year of release and runtime
+ year = movie.get('release_date', [])[:4]
+ runtime = movie.get('runtime')
+ runtime = f"{runtime} minutes" if runtime else None
+
+ # Not all these attributes will always be present
+ movie_attributes = {
+ "Directed by": director,
+ "Starring": ', '.join(cast),
+ "Running time": runtime,
+ "Release year": year,
+ "Spookiness rating": rating,
+ }
+
+ embed = Embed(
+ colour=0x01d277,
+ title='**' + movie.get('title') + '**',
+ url=tmdb_url,
+ description=movie.get('overview')
+ )
+
+ if poster:
+ embed.set_image(url=poster)
+
+ # Add the attributes that we actually have data for, but not the others.
+ for name, value in movie_attributes.items():
+ if value:
+ embed.add_field(name=name, value=value)
+
+ embed.set_footer(text='powered by themoviedb.org')
+
+ return embed
+
+
+def setup(bot):
+ bot.add_cog(Movie(bot))
diff --git a/bot/cogs/spookyreact.py b/bot/cogs/spookyreact.py
new file mode 100644
index 00000000..2652a60e
--- /dev/null
+++ b/bot/cogs/spookyreact.py
@@ -0,0 +1,31 @@
+SPOOKY_TRIGGERS = {
+ 'spooky': "\U0001F47B",
+ 'skeleton': "\U0001F480",
+ 'doot': "\U0001F480",
+ 'pumpkin': "\U0001F383",
+ 'halloween': "\U0001F383",
+ 'jack-o-lantern': "\U0001F383",
+ 'danger': "\U00002620"
+}
+
+
+class SpookyReact:
+
+ """
+ A cog that makes the bot react to message triggers.
+ """
+
+ def __init__(self, bot):
+ self.bot = bot
+
+ async def on_message(self, ctx):
+ """
+ A command to send the hacktoberbot github project
+ """
+ for trigger in SPOOKY_TRIGGERS.keys():
+ if trigger in ctx.content.lower():
+ await ctx.add_reaction(SPOOKY_TRIGGERS[trigger])
+
+
+def setup(bot):
+ bot.add_cog(SpookyReact(bot))
diff --git a/bot/cogs/template.py b/bot/cogs/template.py
index 89f12fe1..aa01432c 100644
--- a/bot/cogs/template.py
+++ b/bot/cogs/template.py
@@ -12,9 +12,12 @@ class Template:
@commands.command(name='repo', aliases=['repository', 'project'], brief='A link to the repository of this bot.')
async def repository(self, ctx):
+ """
+ A command to send the hacktoberbot github project
+ """
await ctx.send('https://github.com/discord-python/hacktoberbot')
- @commands.group(name='git', invoke_without_command=True)
+ @commands.group(name='git', invoke_without_command=True, brief="A link to resources for learning Git")
async def github(self, ctx):
"""
A command group with the name git. You can now create sub-commands such as git commit.
generated by cgit v1.2.3 (git 2.39.1) at 2025-10-22 19:54:04 +0000