Refactor some code points

Author: izxxr

.gitignore

@@ -162,4 +162,6 @@ cython_debug/
 db.sqlite3-shm
 db.sqlite3-wal
 
-test.*
+test.*
+
+.env*

cogs/inventory.py

@@ -65,7 +65,7 @@ async def format_page(self, menu: views.Paginator, page: List[InventoryItem]) ->
             if item.durability is not None:
                 stats += f"Durability: {inv_item.durability}/{item.durability}"
 
-            embed.add_field(name=f"{item.emoji} {item.display_name}", value=stats, inline=True)
+            embed.add_field(name=f"{item.name(bold=False)}", value=stats, inline=True)
 
         return embed
 
@@ -90,7 +90,7 @@ async def _use_item(self, inventory_item: InventoryItem, quantity: int, player:
                 hp_gained = 8
 
             await player.add_hp(hp_gained)
-            return f"{cosmetics.EMOJI_HEALTH_HALF} Ate {quantity} **{data.emoji} {data.display_name}** to restore `{hp_gained}` HP."
+            return f"{cosmetics.EMOJI_HEALTH_HALF} Ate {quantity} {data.name()} to restore `{hp_gained}` HP."
         else:
             return False
 
@@ -124,7 +124,7 @@ async def info(self, interaction: discord.Interaction, item: str):
 
         data = self.bot.items[item]
         embed = discord.Embed(
-            title=f"{data.emoji} {data.display_name}",
+            title=data.name(bold=False),
             description=data.description,
             color=discord.Color.dark_embed(),
         )
@@ -144,7 +144,7 @@ async def info(self, interaction: discord.Interaction, item: str):
             embed.add_field(
                 name="Crafting Recipe",
                 value=f"\n".join(
-                    f"{amount}x {self.bot.items[reqitem].emoji} {self.bot.items[reqitem].display_name}"
+                    f"{amount}x {self.bot.items[reqitem].name(bold=False)}"
                     for reqitem, amount in data.crafting_recipe.items()
                 ),
                 inline=False,
@@ -158,15 +158,15 @@ async def info(self, interaction: discord.Interaction, item: str):
             reqitem = self.bot.items[data.smelting_recipe]
             embed.add_field(
                 name="Smelting Recipe",
-                value=f"{reqitem.emoji} {reqitem.display_name}",
+                value=reqitem.name(bold=False),
                 inline=False,
             )
 
         if data.smelting_product is not None:
             reqitem = self.bot.items[data.smelting_product]
             embed.add_field(
                 name="Smelting Product",
-                value=f"{reqitem.emoji} {reqitem.display_name}",
+                value=reqitem.name(bold=False),
                 inline=False,
             )
 
@@ -210,12 +210,12 @@ async def discard(self, interaction: discord.Interaction, item: str, quantity: s
             amount = int(quantity)
 
         if amount > data.quantity:
-            raise checks.GenericError(f"You don't have this much quantity. You only have `{data.quantity}` **{item_data.emoji} {item_data.display_name}**.")
+            raise checks.GenericError(f"You don't have this much quantity. You only have `{data.quantity}` {item_data.name()}.")
 
         confirmation = views.Confirmation(user=interaction.user, timeout=30)
         embed = discord.Embed(
             title=f"{cosmetics.EMOJI_DANGER} Are you sure?",
-            description=f"You are about to discard `{amount}` **{item_data.emoji} {item_data.display_name}**. After discarding, the item will be lost.",
+            description=f"You are about to discard `{amount}` {item_data.name()}. After discarding, the item will be lost.",
             color=discord.Color.dark_embed(),
         )
 
@@ -226,7 +226,7 @@ async def discard(self, interaction: discord.Interaction, item: str, quantity: s
 
         if confirmation.confirmed:
             await data.remove(amount)
-            message = f"Discarded `{amount}` **{item_data.emoji} {item_data.display_name}**"
+            message = f"Discarded `{amount}` {item_data.name()}"
         else:
             message = f"Action canceled. No changes were made."
 
@@ -267,13 +267,11 @@ async def craft(self, interaction: discord.Interaction, item: str, quantity: int
 
             error_message = ""
             if required_item is None:
-                error_message = f"{cosmetics.EMOJI_WARNING} You need `{crafting_quantity}` **{required_item_data.emoji} " \
-                                f"{required_item_data.display_name}**. You have none."
+                error_message = f"{cosmetics.EMOJI_WARNING} You need `{crafting_quantity}` {required_item_data.name()}. You have none."
             else:
                 required_quantity = crafting_quantity * quantity
                 if required_quantity > required_item.quantity:
-                    error_message = f"{cosmetics.EMOJI_WARNING} You need `{required_quantity}` {required_item_data.emoji} " \
-                                    f"{required_item_data.display_name}. You currently have `{required_item.quantity}` of it."
+                    error_message = f"{cosmetics.EMOJI_WARNING} You need `{required_quantity}` {required_item_data.name()}. You currently have `{required_item.quantity}` of it."
                 else:
                     await required_item.remove(required_quantity)
 
@@ -284,7 +282,7 @@ async def craft(self, interaction: discord.Interaction, item: str, quantity: int
         # craft the given item so add it to inventory.
         quantity_crafted = quantity * item_data.crafting_quantity
         await InventoryItem.add(player=profile, item_id=item, quantity=quantity_crafted, durability=item_data.durability)
-        await interaction.edit_original_response(content=f":carpentry_saw: Crafted `{quantity_crafted}` **{item_data.emoji} {item_data.display_name}**", embed=None)
+        await interaction.edit_original_response(content=f":carpentry_saw: Crafted `{quantity_crafted}` {item_data.name()}", embed=None)
 
     @app_commands.command()
     @checks.has_survival_profile()
@@ -320,7 +318,7 @@ async def smelt(self, interaction: discord.Interaction, item: str, quantity: int
             )
         if inv_item.quantity < quantity:
             return await interaction.edit_original_response(
-                content=f"{cosmetics.EMOJI_WARNING} You only have `{inv_item.quantity}` **{data.emoji} {data.display_name}**.",
+                content=f"{cosmetics.EMOJI_WARNING} You only have `{inv_item.quantity}` {data.name()}.",
                 embed=None,
             )
 
@@ -330,14 +328,14 @@ async def smelt(self, interaction: discord.Interaction, item: str, quantity: int
 
         if coal is None:
             return await interaction.edit_original_response(
-                content=f"{cosmetics.EMOJI_WARNING} You need **{coal_data.emoji} {coal_data.display_name}** to smelt items.",
+                content=f"{cosmetics.EMOJI_WARNING} You need {data.name()} to smelt items.",
                 embed=None,
             )
 
         required_fuel = math.ceil(quantity / 4)
         if coal.quantity < required_fuel:
-            message = f"{cosmetics.EMOJI_WARNING} You need `{required_fuel}` **{coal_data.emoji} {coal_data.display_name}** " \
-                      f"to smelt `{quantity}` **{data.emoji} {data.display_name}**. You only have `{coal.quantity}` of coal."
+            message = f"{cosmetics.EMOJI_WARNING} You need `{required_fuel}` {coal_data.name()} " \
+                      f"to smelt `{quantity}` {data.name()}. You only have `{coal.quantity}` of coal."
 
             return await interaction.edit_original_response(
                 content=message,
@@ -351,11 +349,11 @@ async def smelt(self, interaction: discord.Interaction, item: str, quantity: int
         xp_gained = random.randint(1, 5)
         embed = discord.Embed(
             title=":wood: Smelting",
-            description=f"Successfully smelted `{quantity}` **{data.emoji} {data.display_name}**",
+            description=f"Successfully smelted `{quantity}` {data.name()}",
             color=discord.Color.dark_embed(),
         )
-        embed.add_field(name="Product", value=f"{quantity}x **{item_formed.emoji} {item_formed.display_name}**")
-        embed.add_field(name="Fuel Used", value=f"{required_fuel}x **{coal_data.emoji} {coal_data.display_name}**")
+        embed.add_field(name="Product", value=f"{quantity}x {item_formed.name()}")
+        embed.add_field(name="Fuel Used", value=f"{required_fuel}x {coal_data.name()}")
         embed.set_footer(text=f"+{xp_gained} XP")
 
         await interaction.edit_original_response(embed=embed)

cogs/profile.py

@@ -53,9 +53,38 @@ async def start(self, interaction: discord.Interaction):
                         "Use various commands to collect valuable resources and use them " \
                         "to improve your profile. As you get further, you will level up to " \
                         "higher levels which also gives more amazing perks. Use `/profile view` " \
-                        "to view your profile and progress.\n\nGood Luck!",
+                        "to view your profile and progress. A few tips have been added for you below.\n\nGood Luck!",
             color=discord.Color.green(),
         )
+        
+        embed.add_field(
+            name="Profile",
+            value="Manage your profile from `/profile` command group. View your statistics, " \
+                  "most importantly your health from `/profile view` command. **Don't forget to eat " \
+                  "to heal yourself otherwise dying resets your levels!**",
+            inline=False,
+        )
+        embed.add_field(
+            name="Inventory",
+            value="Manage your inventory from `/inventory` command group. Craft and smelt items to " \
+                  "produce useful tools and items. Use `/inventory info` to get information about items " \
+                  "and `/inventory craft/smelt` to craft or smelt items. To use an item (e.g. eating food), use " \
+                  "`/inventory use`.",
+            inline=False,
+        )
+        embed.add_field(
+            name="Collecting Resources",
+            value="`/explore` command is your first step towards collecting resources. You can " \
+                  "explore different biomes using this command with each biome having specific loot. " \
+                  "As you explore more, you'll discover more rarer biomes which will have even better loot. " \
+                  "Other commands for collecting resources are `/mine` and `/fish`.",
+            inline=False,
+        )
+        embed.add_field(
+            name="Learn More",
+            value="To get info on how something works, use the [docs](https://github.com/izxxr/cobble-bot/tree/main/docs).",
+            inline=False
+        )
 
         await interaction.response.send_message(embed=embed)
 

cogs/survival.py

@@ -126,7 +126,7 @@ def _generate_loot_embed(self, loot: ObtainedLootT, title: str, description: str
         )
 
         embed.add_field(name="Collected Loot", value="\n".join(
-                                                    f"{x[1]}x {x[0].emoji} {x[0].display_name}"
+                                                    f"{x[1]}x {x[0].name(bold=False)}"
                                                     for x in loot))
 
         if xp_gained:
@@ -138,7 +138,7 @@ def _item_break_embed(self, item_id: str) -> discord.Embed:
         item = self.bot.items[item_id]
         embed = discord.Embed(
             title=":adhesive_bandage: Item Broken",
-            description=f"Your **{item.emoji} {item.display_name}** just broke.",
+            description=f"Your {item.name()} just broke.",
             color=discord.Color.red(),
         )
 
@@ -196,7 +196,7 @@ async def explore(self, interaction: discord.Interaction):
         embed = self._generate_loot_embed(
             loot,
             title=":hiking_boot: Exploration",
-            description=f"You explored the **{view.selected_biome.emoji} {view.selected_biome.display_name}**",
+            description=f"You explored the {view.selected_biome.name()}",
             xp_gained=xp_gained,
         )
 
@@ -226,7 +226,7 @@ async def explore(self, interaction: discord.Interaction):
             color=discord.Color.dark_embed(),
         )
 
-        embed.add_field(name="Biome", value=f"{discovered_biome.emoji} {discovered_biome.display_name}")
+        embed.add_field(name="Biome", value=discovered_biome.name(bold=False))
         embed.add_field(name="Information", value=discovered_biome.description)
         embed.add_field(name="Rarity", value=discovered_biome.rarity.title())
         embed.set_image(url=discovered_biome.background)
@@ -248,7 +248,7 @@ async def fish(self, interaction: discord.Interaction):
         if invitem is None:
             fishing_rod = self.bot.items["fishing_rod"]
             return await interaction.edit_original_response(
-                content=f"{cosmetics.EMOJI_WARNING} You need a **{fishing_rod.emoji} {fishing_rod.display_name}** to fish.",
+                content=f"{cosmetics.EMOJI_WARNING} You need a {fishing_rod.name()} to fish.",
                 embed=None,
             )
 

core/datamodels/biome.py

@@ -52,3 +52,7 @@ def discovered(self, player: Player) -> bool:
         if val == 0:
             return True
         return (player.achievements & val) == val
+
+    def name(self, bold: bool = True) -> str:
+        n = f"{self.emoji} {self.display_name}"
+        return f"**{n}**" if bold else n

core/datamodels/item.py

@@ -46,3 +46,8 @@ class Item:
     durability: Optional[int] = None
     crafting_quantity: int = 1
     food_hp_restored: Optional[float] = None
+
+
+    def name(self, bold: bool = True) -> str:
+        n = f"{self.emoji} {self.display_name}"
+        return f"**{n}**" if bold else n