Farm: Added farm logging.

Author: Ambratolm

bot/cogs/console_cog.py

@@ -73,7 +73,7 @@ async def sync(self, interaction: Interaction, global_sync: bool = True):
         await interaction.followup.send(
             embed=EmbedX.success(
                 title="Commands Synchronization",
-                description=f"{count[0]}/{count[1]} command(s) synchronized.",
+                description=f"{count[0]}/{count[1]} command(s) synchronized{" globally" if global_sync else f" to guild: {interaction.guild}"}.",
             ),
             ephemeral=True,
         )

bot/cogs/game_cogs/farm_cog.py

@@ -1,12 +1,28 @@
 import re
 from random import randint
 
-from discord import Member, Message, Role, utils
+from discord import (
+    Attachment,
+    Embed,
+    Guild,
+    HTTPException,
+    Interaction,
+    Member,
+    Message,
+    Role,
+    StickerItem,
+    TextChannel,
+    User,
+    VoiceChannel,
+    app_commands,
+    utils,
+)
 from discord.ext.commands import Cog
 
 from bot.main import ActBot
 from bot.ui.embed import EmbedX
 from db.actor import Actor
+from db.room import Room
 from utils.xp import Experience
 
 
@@ -17,11 +33,78 @@ class FarmCog(Cog, description="Allow players to gain stats and roles"):
     def __init__(self, bot: ActBot):
         self.bot = bot
 
+    # ----------------------------------------------------------------------------------------------------
+    # * Set Farm Log
+    # ----------------------------------------------------------------------------------------------------
+    @app_commands.guild_only()
+    @app_commands.checks.has_permissions(administrator=True)
+    @app_commands.default_permissions(administrator=True)
+    @app_commands.command(
+        description="Set or get farm log channel", extras={"category": "Farm"}
+    )
+    async def set_farm_log(
+        self,
+        interaction: Interaction,
+        channel: TextChannel | None = None,
+        unset: bool = False,
+    ):
+        if not interaction.guild:
+            return await interaction.response.send_message(
+                embed=EmbedX.error(
+                    title="Guild Only",
+                    description="This command can only be used in a server.",
+                ),
+                ephemeral=True,
+            )
+
+        if unset:
+            self.delete_room(id=FarmCog.__name__, guild=interaction.guild)
+            return await interaction.response.send_message(
+                embed=EmbedX.success(
+                    title="Farm Log Channel Unset",
+                    description="Farm log channel has been unset.",
+                ),
+                ephemeral=True,
+            )
+
+        if not channel:
+            log_room = self.load_room(id=FarmCog.__name__, guild=interaction.guild)
+            log_channel = (
+                interaction.guild.get_channel(log_room.channel_id) if log_room else None
+            )
+            return await interaction.response.send_message(
+                embed=EmbedX.info(
+                    title="Farm Log Channel",
+                    description=(
+                        f"Current farm log channel is {log_channel.mention}"
+                        if log_channel
+                        else "No farm log channel set."
+                    ),
+                ),
+                ephemeral=True,
+            )
+
+        self.save_room(id=FarmCog.__name__, channel=channel)
+        await interaction.response.send_message(
+            embed=EmbedX.success(
+                title="Farm Log Channel Set",
+                description=f"Farm log channel has been set to {channel.mention}.",
+            ),
+            ephemeral=True,
+        )
+
     # ----------------------------------------------------------------------------------------------------
     # * On Member Join
     # ----------------------------------------------------------------------------------------------------
     @Cog.listener()
     async def on_member_join(self, member: Member):
+        log_room = self.load_room(id=FarmCog.__name__, guild=member.guild)
+        log_channel = (
+            member.guild.get_channel(log_room.channel_id) if log_room else None
+        )
+        if log_channel and isinstance(log_channel, TextChannel):
+            await log_channel.send(f"🟢 {member.mention} joined.")
+
         db = self.bot.get_db(member.guild)
         actor = db.find_one(Actor, Actor.id == member.id)
         if not actor:
@@ -34,6 +117,13 @@ async def on_member_join(self, member: Member):
     # ----------------------------------------------------------------------------------------------------
     @Cog.listener()
     async def on_member_remove(self, member: Member):
+        log_room = self.load_room(id=FarmCog.__name__, guild=member.guild)
+        log_channel = (
+            member.guild.get_channel(log_room.channel_id) if log_room else None
+        )
+        if log_channel and isinstance(log_channel, TextChannel):
+            await log_channel.send(f"🔴 {member.mention} left.")
+
         db = self.bot.get_db(member.guild)
         actor = db.find_one(Actor, Actor.id == member.id)
         if not actor:
@@ -69,21 +159,27 @@ async def on_message(self, message: Message):
         print(f"👤 @{member.name} earned {xp_reward} xp.")
 
         # Log xp gain to a "log" named channel
-        # TODO: This works better with a feature allowing to set log channel per server (maybe a command)
-        # 🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴
-        # log_channel = utils.find(
-        #     lambda c: "📜・log" in c.name.lower(), message.guild.text_channels
-        # )
-        # if log_channel:
-        #     embed = EmbedX.info(
-        #         emoji="", title="", description=f"{member.mention} earned experience."
-        #     )
-        #     embed.add_field(name="Experience 🔼", value=f"**⏫ +{xp_reward} **")
-        #     embed.set_author(
-        #         name=member.display_name, icon_url=member.display_avatar.url
-        #     )
-        #     await log_channel.send(embed=embed)
-        # 🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴🔴
+        log_room = self.load_room(id=FarmCog.__name__, guild=message.guild)
+        log_channel = (
+            message.guild.get_channel(log_room.channel_id) if log_room else None
+        )
+        if log_channel and isinstance(log_channel, TextChannel):
+            # embed = EmbedX.info(
+            #     emoji="",
+            #     title="",
+            #     description=f"⏫ {member.mention} earned experience.",
+            # )
+            # embed.add_field(name="Experience 🔼", value=f"**⏫ +{xp_reward} **")
+            # embed.set_author(
+            #     name=member.display_name, icon_url=member.display_avatar.url
+            # )
+            # embed = EmbedX.info(
+            #     emoji="",
+            #     title="",
+            #     description=f"**⏫ +{xp_reward}** XP for {member.mention}.",
+            # )
+            # await log_channel.send(embed=embed)
+            await log_channel.send(f"{member.display_name} earned **{xp_reward}** xp.")
 
         # Try level-up
         if actor.try_level_up():
@@ -126,6 +222,23 @@ async def on_message(self, message: Message):
 
     # ----------------------------------------------------------------------------------------------------
 
+    def save_room(self, id: str, channel: TextChannel | VoiceChannel):
+        db = self.bot.get_db(channel.guild)
+        room = db.find_one(Room, Room.id == id) or self.bot.create_room(id, channel)
+        room.channel_id = channel.id
+        room.channel_name = channel.name
+        room.channel_is_voice = isinstance(channel, VoiceChannel)
+        db.save(room)
+
+    def delete_room(self, id: str, guild: Guild):
+        db = self.bot.get_db(guild)
+        room = db.find_one(Room, Room.id == id)
+        if room:
+            db.delete(room)
+
+    def load_room(self, id: str, guild: Guild) -> Room | None:
+        return self.bot.get_db(guild).find_one(Room, Room.id == id)
+
     # @staticmethod
     # async def try_award_role(member: Member, role_name: str) -> Role | None:
     #     role = utils.get(member.guild.roles, name=role_name)

bot/main.py

@@ -2,13 +2,25 @@
 from typing import Any
 
 from colorama import Fore
-from discord import Guild, Interaction, Member, Message, Object, User, app_commands
+from discord import (
+    Guild,
+    Interaction,
+    Member,
+    Message,
+    Object,
+    TextChannel,
+    User,
+    VoiceChannel,
+    app_commands,
+)
+from discord.abc import Messageable
 from discord.ext.commands import Bot, Cog
 from odmantic import SyncEngine, query
 
 from bot.ui.embed import EmbedX
 from db.actor import Actor, DmActor
 from db.main import ActDb, DbRef
+from db.room import Room
 from utils.log import logger
 from utils.misc import import_classes, text_block
 
@@ -209,6 +221,15 @@ def create_dm_actor(self, user: User) -> DmActor:
         """Create dm-actor from given user."""
         return DmActor(id=user.id, name=user.name, display_name=user.display_name)
 
+    def create_room(self, id: str, channel: TextChannel | VoiceChannel) -> Room:
+        """Create Room from given discord channel."""
+        return Room(
+            id=id,
+            channel_id=channel.id,
+            channel_name=channel.name,
+            channel_is_voice=isinstance(channel, VoiceChannel),
+        )
+
     # ----------------------------------------------------------------------------------------------------
 
     async def get_actors_members(

db/room.py

@@ -0,0 +1,13 @@
+from odmantic import Field, Model
+
+
+# -------------------------------------------------------------------------------------------------
+# * Room
+# -------------------------------------------------------------------------------------------------
+class Room(Model):
+    model_config = {"collection": "rooms"}
+
+    id: str = Field(primary_field=True)
+    channel_id: int
+    channel_name: str = ""
+    channel_is_voice: bool = False