feat: support custom timeout seconds and embed color for game settings

Author: Strengthless

bot/exts/fun/adventure.py

@@ -31,6 +31,8 @@ class GameInfo(TypedDict):
     id: str
     name: str
     description: str
+    color: str
+    time: int
 
 
 BASE_PATH = "bot/resources/fun/adventures"
@@ -72,7 +74,7 @@ class EndRoomData(TypedDict):
     emoji: str
 
 
-class AdventureData(TypedDict):
+class GameData(TypedDict):
     """
     A dictionary containing the game data, serialized from a JSON file in `resources/fun/adventures`.
 
@@ -102,17 +104,20 @@ class GameSession:
     def __init__(
         self,
         ctx: Context,
-        game_code: str | None = None,
+        game_code_or_index: str | None = None,
     ):
         """Creates an instance of the GameSession class."""
         self._ctx = ctx
         self._bot = ctx.bot
 
         # set the game details/ game codes required for the session
-        self.game_code = game_code
+        self.game_code = game_code_or_index
         self.game_data = None
-        if game_code:
-            self.game_data = self._get_game_data(game_code)
+        self.game_info = None
+        if game_code_or_index:
+            self.game_code = self._parse_game_code(game_code_or_index)
+            self.game_data = self._get_game_data()
+            self.game_info = self._get_game_info()
 
         # store relevant discord info
         self.author = ctx.author
@@ -125,25 +130,31 @@ def __init__(
         self._effects: list[str] = []
 
         # session settings
+        self._timeout_seconds = 30 if self.game_info is None else self.game_info["time"]
         self.timeout_message = (
-            "⏳ Hint: time is running out! You must make a choice within 60 seconds."
+            f"⏳ Hint: time is running out! You must make a choice within {self._timeout_seconds} seconds."
         )
         self._timeout_task = None
         self.reset_timeout()
 
-    def _get_game_data(self, game_code: str) -> AdventureData | None:
-        """Returns the game data for the given game code."""
+    def _parse_game_code(self, game_code_or_index: str) -> str:
+        """Returns the actual game code for the given index/ game code."""
         # sanitize the game code to prevent directory traversal attacks.
-        game_code = Path(game_code).name
+        game_code = Path(game_code_or_index).name
 
-        # Convert index to game code if it's a number
+        # convert index to game code if it's a number
         try:
-            index = int(game_code)
+            index = int(game_code_or_index)
             game_code = AVAILABLE_GAMES[index - 1]["id"]
-            self.game_code = game_code
         except (ValueError, IndexError):
             pass
 
+        return game_code
+
+    def _get_game_data(self) -> GameData | None:
+        """Returns the game data for the given game code."""
+        game_code = self.game_code
+
         # load the game data from the JSON file
         try:
             game_data = json.loads(
@@ -153,14 +164,27 @@ def _get_game_data(self, game_code: str) -> AdventureData | None:
         except FileNotFoundError:
             raise GameCodeNotFoundError(f'Game code "{game_code}" not found.')
 
+    def _get_game_info(self) -> GameInfo:
+        """Returns the game info for the given game code."""
+        game_code = self.game_code
+
+        try:
+            return AVAILABLE_GAMES_DICT[game_code]
+        except KeyError:
+            log.error(
+                "Game data retrieved, but game info not found. Did you forget to add it to `available_games.json`?"
+            )
+            raise GameCodeNotFoundError(f'Game code "{game_code}" not found.')
+
     async def notify_timeout(self) -> None:
         """Notifies the user that the session has timed out."""
         await self.message.edit(content="⏰ You took too long to make a choice! The game has ended. :(")
 
-    async def timeout(self, seconds: int = 60) -> None:
+    async def timeout(self) -> None:
         """Waits for a set number of seconds, then stops the game session."""
-        await asyncio.sleep(seconds)
+        await asyncio.sleep(self._timeout_seconds)
         await self.notify_timeout()
+        await self.message.clear_reactions()
         await self.stop()
 
     def cancel_timeout(self) -> None:
@@ -259,7 +283,7 @@ def _format_room_data(self, room_data: RoomData) -> str:
     def embed_message(self, room_data: RoomData | EndRoomData) -> Embed:
         """Returns an Embed with the requested room data formatted within."""
         embed = Embed()
-        embed.color = constants.Colours.soft_orange
+        embed.color = int(self.game_info["color"], base=16)
 
         current_game_name = AVAILABLE_GAMES_DICT[self.game_code]["name"]
 
@@ -291,9 +315,9 @@ async def update_message(self, room_id: str) -> None:
             self.add_reactions()
 
     @classmethod
-    async def start(cls, ctx: Context, game_code: str | None = None) -> "GameSession":
+    async def start(cls, ctx: Context, game_code_or_index: str | None = None) -> "GameSession":
         """Create and begin a game session based on the given game code."""
-        session = cls(ctx, game_code)
+        session = cls(ctx, game_code_or_index)
         await session.prepare()
 
         return session
@@ -355,10 +379,10 @@ class Adventure(DiscordCog):
     """Custom Embed for Adventure RPG games."""
 
     @commands.command(name="adventure")
-    async def new_adventure(self, ctx: Context, game_code: str | None = None) -> None:
+    async def new_adventure(self, ctx: Context, game_code_or_index: str | None = None) -> None:
         """Wanted to slay a dragon? Embark on an exciting journey through text-based RPG adventure."""
         try:
-            await GameSession.start(ctx, game_code)
+            await GameSession.start(ctx, game_code_or_index)
         except GameCodeNotFoundError as error:
             await ctx.send(str(error))
 

bot/resources/fun/adventures/available_games.json

@@ -2,16 +2,22 @@
   {
     "id": "three_little_pigs",
     "name": "Three Little Pigs",
-    "description": "A wolf is on the prowl! You are one of the three little pigs. Try to survive by building a house."
+    "description": "A wolf is on the prowl! You are one of the three little pigs. Try to survive by building a house.",
+    "color": "0x1DA1F2",
+    "time": 30
   },
   {
     "id": "dragon_slayer",
     "name": "Dragon Slayer",
-    "description": "A dragon is terrorizing the kingdom! You are a brave knight, tasked with rescuing the princess and defeating the dragon."
+    "description": "A dragon is terrorizing the kingdom! You are a brave knight, tasked with rescuing the princess and defeating the dragon.",
+    "color": "0x1F8B4C",
+    "time": 60
   },
   {
     "id": "Gurfelts_haunted_mansion",
     "name": "Gurfelt's Haunted Mansion",
-    "description": "Explore a haunted mansion and uncover its secrets!"
+    "description": "Explore a haunted mansion and uncover its secrets!",
+    "color": "0xB734EB",
+    "time": 60
   }
 ]