Update README.md

Author: Kostadinos J Kyprianos

README.md

@@ -1,4 +1,10 @@
-import { Client, GatewayIntentBits, TextChannel, ThreadChannel, ChannelType, EmbedBuilder } from 'discord.js';
+/**
+ * 🏺 Ritual Scroll: badgeEmitter.ts
+ * Description: Listens for sponsorPing events, logs relic drops, and broadcasts
+ *              badge-ceremony embeds across configured Discord channels.
+ */
+
+import { Client, GatewayIntentBits, TextChannel, ThreadChannel, ChannelType } from 'discord.js';
 import { BadgeClient } from 'kypria-badge-sdk';
 import { promises as fs } from 'fs';
 import path from 'path';
@@ -22,9 +28,10 @@ type Relic = SponsorPingPayload & {
 };
 
 (async () => {
-  // 1. Load & validate badge‐locations.yml
+  // 1️⃣ Load & validate badge-locations.yml
   const cfgPath = path.resolve(__dirname, '../config/badge-locations.yml');
-  let config: Config;
+  let config: Config = {};
+
   try {
     const raw = await fs.readFile(cfgPath, 'utf8');
     config = (yaml.load(raw) as Config) ?? {};
@@ -33,49 +40,50 @@ type Relic = SponsorPingPayload & {
     process.exit(1);
   }
 
-  // 2. Initialize clients
+  // 2️⃣ Initialize clients
   const badgeClient = new BadgeClient({ apiToken: process.env.BADGE_API_TOKEN! });
-  const discord = new Client({ intents: [GatewayIntentBits.Guilds] });
+  const discord    = new Client({ intents: [GatewayIntentBits.Guilds] });
 
   discord.once('ready', () => {
     console.log(`✅ Discord bot ready as ${discord.user?.tag}`);
   });
 
-  // 3. Handle sponsorPing
+  // 3️⃣ Handle sponsorPing events
   badgeClient.on('sponsorPing', async ({ sponsorId, badgeName }: SponsorPingPayload) => {
-    const channels = config[badgeName]?.drop_channels ?? [];
+    const channels  = config[badgeName]?.drop_channels ?? [];
     const timestamp = new Date().toISOString();
-    const threadId = `thread-${timestamp.replace(/[:.]/g, '-')}`;
+    const threadId  = `thread-${timestamp.replace(/[:.]/g, '-')}`;
     const relic: Relic = { sponsorId, badgeName, timestamp, threadId };
 
-    // 3a. Audit-log relic
-    const logDir = path.resolve(__dirname, '../threads');
+    // 3a️⃣ Audit-log the relic
+    const logDir  = path.resolve(__dirname, '../threads');
     await fs.mkdir(logDir, { recursive: true });
-    const outPath = path.join(logDir, `relic-drop--${badgeName}--${timestamp}.json`);
+    const fileName = `relic-drop--${badgeName}--${timestamp}.json`;
+    const outPath  = path.join(logDir, fileName);
     await fs.writeFile(outPath, JSON.stringify(relic, null, 2));
 
-    // 3b. Broadcast badge-drop
+    // 3b️⃣ Broadcast the badge ceremony
     for (const chId of channels) {
       try {
         const channel = await discord.channels.fetch(chId);
         if (
           channel &&
-          (channel.type === ChannelType.GuildText || channel.type === ChannelType.GuildPublicThread)
+          (channel.type === ChannelType.GuildText ||
+           channel.type === ChannelType.GuildPublicThread)
         ) {
-          // wrap payload with embed title
           await dropBadge(channel as TextChannel | ThreadChannel, {
             ...relic,
             title: `🏅 ${badgeName}`,
           });
         } else {
-          console.warn(`⚠️ Channel ${chId} is not a text/thread channel. Skipping.`);
+          console.warn(`⚠️ Skipping non-text/thread channel: ${chId}`);
         }
       } catch (err) {
-        console.error(`❌ Failed to drop badge in channel ${chId}:`, err);
+        console.error(`❌ Error dropping badge in ${chId}:`, err);
       }
     }
   });
 
-  // 4. Connect to Discord
+  // 4️⃣ Connect to Discord
   await discord.login(process.env.DISCORD_TOKEN);
 })();