1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
from pathlib import Path
from random import choice
from discord import Embed, Message
from discord.ext import commands
from bot.bot import Bot
from bot.constants import Colours, NEGATIVE_REPLIES
# Defining all words in the list of words as a global variable
ALL_WORDS = Path("bot/resources/fun/hangman_words.txt").read_text().splitlines()
# Defining a dictionary of images that will be used for the game to represent the hangman person
IMAGES = {
6: "https://cdn.discordapp.com/attachments/859123972884922418/888133201497837598/hangman0.png",
5: "https://cdn.discordapp.com/attachments/859123972884922418/888133595259084800/hangman1.png",
4: "https://cdn.discordapp.com/attachments/859123972884922418/888134194474139688/hangman2.png",
3: "https://cdn.discordapp.com/attachments/859123972884922418/888133758069395466/hangman3.png",
2: "https://cdn.discordapp.com/attachments/859123972884922418/888133786724859924/hangman4.png",
1: "https://cdn.discordapp.com/attachments/859123972884922418/888133828831477791/hangman5.png",
0: "https://cdn.discordapp.com/attachments/859123972884922418/888133845449338910/hangman6.png",
}
class Hangman(commands.Cog):
"""
Cog for the Hangman game.
Hangman is a classic game where the user tries to guess a word, with a limited amount of tries.
"""
def __init__(self, bot: Bot):
self.bot = bot
@staticmethod
def create_embed(tries: int, user_guess: str) -> Embed:
"""
Helper method that creates the embed where the game information is shown.
This includes how many letters the user has guessed so far, and the hangman photo itself.
"""
hangman_embed = Embed(
title="Hangman",
color=Colours.python_blue,
)
hangman_embed.set_image(url=IMAGES[tries])
hangman_embed.add_field(
name=f"You've guessed `{user_guess}` so far.",
value="Guess the word by sending a message with a letter!"
)
hangman_embed.set_footer(text=f"Tries remaining: {tries}")
return hangman_embed
@commands.command()
async def hangman(
self,
ctx: commands.Context,
min_length: int = 0,
max_length: int = 25,
min_unique_letters: int = 0,
max_unique_letters: int = 25,
) -> None:
"""
Play hangman against the bot, where you have to guess the word it has provided!
The arguments for this command mean:
- min_length: the minimum length you want the word to be (i.e. 2)
- max_length: the maximum length you want the word to be (i.e. 5)
- min_unique_letters: the minimum unique letters you want the word to have (i.e. 4)
- max_unique_letters: the maximum unique letters you want the word to have (i.e. 7)
"""
# Filtering the list of all words depending on the configuration
filtered_words = [
word for word in ALL_WORDS
if min_length < len(word) < max_length
and min_unique_letters < len(set(word)) < max_unique_letters
]
if not filtered_words:
filter_not_found_embed = Embed(
title=choice(NEGATIVE_REPLIES),
description="No words could be found that fit all filters specified.",
color=Colours.soft_red,
)
await ctx.send(embed=filter_not_found_embed)
return
word = choice(filtered_words)
# `pretty_word` is used for comparing the indices where the guess of the user is similar to the word
# The `user_guess` variable is prettified by adding spaces between every dash, and so is the `pretty_word`
pretty_word = "".join([f"{letter} " for letter in word])[:-1]
user_guess = ("_ " * len(word))[:-1]
tries = 6
guessed_letters = set()
def check(msg: Message) -> bool:
return msg.author == ctx.author and msg.channel == ctx.channel
original_message = await ctx.send(embed=Embed(
title="Hangman",
description="Loading game...",
color=Colours.soft_green
))
# Game loop
while user_guess.replace(" ", "") != word:
# Edit the message to the current state of the game
await original_message.edit(embed=self.create_embed(tries, user_guess))
try:
message = await self.bot.wait_for(
"message",
timeout=60.0,
check=check
)
except TimeoutError:
timeout_embed = Embed(
title="You lost",
description=f"Time's up! The correct word was `{word}`.",
color=Colours.soft_red,
)
await ctx.send(embed=timeout_embed)
return
# If the user enters a capital letter as their guess, it is automatically converted to a lowercase letter
normalized_content = message.content.lower()
# The user should only guess one letter per message
if len(normalized_content) > 1:
letter_embed = Embed(
title=choice(NEGATIVE_REPLIES),
description="You can only send one letter at a time, try again!",
color=Colours.dark_green,
)
await ctx.send(embed=letter_embed, delete_after=4)
continue
# Checks for repeated guesses
if normalized_content in guessed_letters:
already_guessed_embed = Embed(
title=choice(NEGATIVE_REPLIES),
description=f"You have already guessed `{normalized_content}`, try again!",
color=Colours.dark_green,
)
await ctx.send(embed=already_guessed_embed, delete_after=4)
continue
# Checks for correct guesses from the user
if normalized_content in word:
positions = {idx for idx, letter in enumerate(pretty_word) if letter == normalized_content}
user_guess = "".join(
[normalized_content if index in positions else dash for index, dash in enumerate(user_guess)]
)
else:
tries -= 1
if tries <= 0:
losing_embed = Embed(
title="You lost.",
description=f"The word was `{word}`.",
color=Colours.soft_red,
)
await original_message.edit(embed=self.create_embed(tries, user_guess))
await ctx.send(embed=losing_embed)
return
guessed_letters.add(normalized_content)
# The loop exited meaning that the user has guessed the word
await original_message.edit(embed=self.create_embed(tries, user_guess))
win_embed = Embed(
title="You won!",
description=f"The word was `{word}`.",
color=Colours.grass_green
)
await ctx.send(embed=win_embed)
async def setup(bot: Bot) -> None:
"""Load the Hangman cog."""
await bot.add_cog(Hangman(bot))
|
