feat: added more help commands

docs/guide/about.md

@@ -0,0 +1,10 @@
+# About
+
+Blitzkrieg is a multipurpose bot for anything and everything World of Tanks Blitz.
+
+- Track statistics
+- Find inactive players in a clan
+- Lookup owned tanks
+- Create embeds for streams
+- Track a player/tanks statistical evolution
+- ...and a variety of other similar things

docs/guide/embeds.md

@@ -0,0 +1,23 @@
+# Embeds
+
+Embeds are generated by a few commands as a URL that can be loaded in a browser/streaming software.
+
+## Creating Embeds
+
+1. Use a command of your liking (for example, `/stats`).
+2. Customize the command however you like and the URL generated for the embed will match your needs.
+3. Send the command and when the bot is "done thinking," an "Embed" button will appear below the bot's reply.
+
+## Using Embeds in Streaming Softwares
+
+1. Click on the "Embed" button.
+2. Copy the URL from your browser.
+3. Paste the URL into a Browser Source.
+4. Set the refresh rate/FPS to something very low like `0.0167` (that's 1 frame every 60 seconds).
+
+## How Embeds Behave
+
+- They load like any normal website albeit with a significant delay.
+- They auto refresh every `60s`.
+- All embeds and images generated by Blitzkrieg have a width of `640px` but the height varies and must be found manually through trial and error.
+  - It's okay to have a Browser Source that has a height larger than needed as Blitzkrieg embeds are transparent.

docs/guide/invite.md

@@ -0,0 +1,10 @@
+# Inviting the Bot
+
+It's quite simple really. Just follow the steps below:
+
+1. Join a Discord server that already has Blitzkrieg installed or [the official Discord Server](https://discord.gg/nDt7AjGJQH).
+2. Click on the bot's profile.
+3. Click the "Add to Server" button under the bot's name and ID.
+4. Select what server you want it in and see what permissions you seem fit for the bot.
+
+Voila! You're ready to go.

src/commands/help.ts

@@ -1,36 +1,105 @@
-import { SlashCommandBuilder } from 'discord.js';
+import {
-import discord from '../../discord.json' assert { type: 'json' };
+  SlashCommandBuilder,
-import { client } from '../bot.js';
+  SlashCommandSubcommandBuilder,
+  SlashCommandSubcommandGroupBuilder,
+} from 'discord.js';
 import embedInfo from '../core/discord/embedInfo.js';
 import {
+  COMMANDS_RAW,
   CommandRegistry,
-  guildCommands,
-  publicCommands,
 } from '../events/interactionCreate/index.js';
 
+const RAW_PATH = `https://raw.githubusercontent.com/tresabhi/blitzkrieg/main/docs/`;
+const DOCS: Record<string, string> = {
+  permissions: 'guide/permissions',
+  embeds: 'guide/embeds',
+  about: 'guide/about',
+  invite: 'guide/invite',
+};
+
 export const helpCommand: CommandRegistry = {
   inProduction: true,
-  inDevelopment: false,
+  inDevelopment: true,
   inPublic: true,
 
   command: new SlashCommandBuilder()
     .setName('help')
-    .setDescription('All the help you need about the bot'),
+    .setDescription('All the help you need about the bot')
+    .addSubcommand((option) =>
+      option
+        .setName('commands')
+        .setDescription('List of all commands and their descriptions'),
+    )
+    .addSubcommand((option) =>
+      option
+        .setName('permissions')
+        .setDescription('The permissions needed for the bot to function'),
+    )
+    .addSubcommand((option) =>
+      option.setName('about').setDescription('About the bot'),
+    )
+    .addSubcommand((option) =>
+      option.setName('embeds').setDescription('How embeds work'),
+    )
+    .addSubcommand((option) =>
+      option.setName('invite').setDescription('How to invite the bot'),
+    ),
 
   handler(interaction) {
-    return embedInfo(
+    const subcommand = interaction.options.getSubcommand();
-      `${client.user?.username} help`,
+
-      `**About**\n${
+    if (subcommand === 'commands') {
-        client.user?.username
+      return [
-      } automates many mundane tasks and provide statistics in numerous flexible ways.\n\nMade by TresAbhi from the Skilled [SKLLD] clan.\nGitHub: https://github.com/tresabhi/blitzkrieg\nDiscord server: https://discord.gg/nDt7AjGJQH\nSkilled server: https://discord.gg/ZPvcEG7DS8\n\n**Commands**\n${(interaction.guildId ===
+        `# Commands\n\nBlitzkrieg offers the following commands:`,
-      discord.sklld_guild_id
+        embedInfo(
-        ? [...guildCommands, ...publicCommands]
+          '',
-        : publicCommands
+          COMMANDS_RAW.filter(
-      )
+            (registry) => registry.inPublic && registry.inProduction,
-        .map((command) => `**/${command.name}**: ${command.description}`)
+          )
-        .join(
+            .map((registry) => {
-          '\n',
+              const info = `- \`/${registry.command.name}\`: ${registry.command.description}`;
-        )}\n\n*I am a new bot; I may make mistakes and go offline unexpectedly from time to time.*`,
+              const subcommandGroups = registry.command.options.filter(
-    );
+                (option) =>
+                  option instanceof SlashCommandSubcommandGroupBuilder,
+              ) as SlashCommandSubcommandGroupBuilder[];
+              const subcommands = registry.command.options.filter(
+                (option) => option instanceof SlashCommandSubcommandBuilder,
+              ) as SlashCommandSubcommandBuilder[];
+
+              const tree =
+                subcommandGroups.length > 0
+                  ? subcommandGroups
+                      .map((subcommandGroup) => {
+                        const info = `  - \`${subcommandGroup.name}\`: ${subcommandGroup.description}`;
+                        const subcommands = subcommandGroup.options
+                          .map(
+                            (subcommand) =>
+                              `    - \`${subcommand.name}\`: ${subcommand.description}`,
+                          )
+                          .join('\n');
+
+                        return `${info}${
+                          subcommands ? `\n${subcommands}` : ''
+                        }`;
+                      })
+                      .join('\n')
+                  : subcommands
+                      .map(
+                        (subcommand) =>
+                          `  - \`${subcommand.name}\`: ${subcommand.description}`,
+                      )
+                      .join('\n');
+
+              return `${info}${tree ? `\n${tree}` : ''}`;
+            })
+            .join('\n'),
+        ),
+      ];
+    }
+
+    const url = `${RAW_PATH}${DOCS[subcommand]}.md`;
+    const content = fetch(url).then((response) => response.text());
+
+    return content;
   },
 };

src/commands/ownedTanks.tsx

@@ -45,7 +45,7 @@ const COMP_TANKS = [
 
 export const ownedTanksCommand: CommandRegistry = {
   inProduction: true,
-  inDevelopment: true,
+  inDevelopment: false,
   inPublic: true,
 
   command: new SlashCommandBuilder()

src/commands/stats.tsx

@@ -20,7 +20,7 @@ import { AccountInfo } from '../types/accountInfo.js';
 
 export const statsCommand: CommandRegistry = {
   inProduction: true,
-  inDevelopment: true,
+  inDevelopment: false,
   inPublic: true,
 
   command: addStatTypeSubCommandGroups(

src/commands/today.tsx

@@ -15,7 +15,7 @@ import { AccountInfo } from '../types/accountInfo.js';
 
 export const todayCommand: CommandRegistry = {
   inProduction: true,
-  inDevelopment: true,
+  inDevelopment: false,
   inPublic: true,
 
   command: new SlashCommandBuilder()

src/components/Breakdown/components/Row.tsx

@@ -40,11 +40,7 @@ export function Row({
         display: 'flex',
         borderRadius: 4,
         backgroundColor: isListing
-          ? naked
+          ? theme.colors.componentInteractive
-            ? theme.colors.componentInteractive_transparent
-            : theme.colors.componentInteractive
-          : naked
-          ? theme.colors.appBackground2_transparent
           : theme.colors.appBackground2,
         padding: 8,
       }}

src/core/discord/embedInfo.ts

@@ -2,8 +2,11 @@ import { EmbedBuilder } from 'discord.js';
 import { ACCENT_COLOR } from '../../constants/colors.js';
 
 export default function embedInfo(title: string, description: string) {
-  return new EmbedBuilder()
+  const embed = new EmbedBuilder()
     .setColor(ACCENT_COLOR)
-    .setTitle(title)
     .setDescription(description);
+
+  if (title) embed.setTitle(title);
+
+  return embed;
 }

src/core/discord/normalizeInteractionReturnable.ts

@@ -19,7 +19,9 @@ export default async function normalizeInteractionReturnable(
 
   await Promise.all(
     normalizedReturnable.map(async (item) => {
-      if (item instanceof EmbedBuilder) {
+      if (typeof item === 'string') {
+        reply.content = item;
+      } else if (item instanceof EmbedBuilder) {
         if (!reply.embeds) reply.embeds = [];
         reply.embeds.push(item);
       } else if (item instanceof ButtonBuilder) {

src/events/interactionCreate/index.ts

@@ -16,6 +16,7 @@ import discord from '../../../discord.json' assert { type: 'json' };
 import { debugCommand } from '../../commands/debug.js';
 import { eligibleCommand } from '../../commands/eligible.js';
 import { evolutionCommand } from '../../commands/evolution.js';
+import { fullStatsCommand } from '../../commands/fullStats.js';
 import { helpCommand } from '../../commands/help.js';
 import { inactiveCommand } from '../../commands/inactive.js';
 import { ownedTanksCommand } from '../../commands/ownedTanks.js';
@@ -26,7 +27,6 @@ import { searchClansCommand } from '../../commands/searchClans.js';
 import { searchPlayersCommand } from '../../commands/searchPlayers.js';
 import { searchTanksCommand } from '../../commands/searchTanks.js';
 import { statsCommand } from '../../commands/stats.js';
-import { fullStatsCommand } from '../../commands/fullStats.js';
 import { todayCommand } from '../../commands/today.js';
 import { verifyCommand } from '../../commands/verify.js';
 import { DISCORD_TOKEN } from '../../core/node/arguments.js';
@@ -37,6 +37,7 @@ import handleButton from './handlers/button.js';
 import handleChatInputCommand from './handlers/chatInputCommand.js';
 
 export type InteractionRawReturnable =
+  | string
   | EmbedBuilder
   | ButtonBuilder
   | JSX.Element;
@@ -70,29 +71,31 @@ export interface CommandRegistry<HandlesInteraction extends boolean = boolean>
 
 const rest = new REST().setToken(DISCORD_TOKEN);
 
-export const commands: Record<string, CommandRegistry> = (
+export const COMMANDS_RAW: CommandRegistry[] = [
-  [
+  debugCommand,
-    debugCommand,
+  eligibleCommand,
-    eligibleCommand,
+  helpCommand,
-    helpCommand,
+  inactiveCommand,
-    inactiveCommand,
+  ownedTanksCommand,
-    ownedTanksCommand,
+  playerAchievementsCommand,
-    playerAchievementsCommand,
+  playerInfoCommand,
-    playerInfoCommand,
+  searchClansCommand,
-    searchClansCommand,
+  searchPlayersCommand,
-    searchPlayersCommand,
+  searchTanksCommand,
-    searchTanksCommand,
+  fullStatsCommand,
-    fullStatsCommand,
+  todayCommand,
-    todayCommand,
+  verifyCommand,
-    verifyCommand,
+  pingCommand,
-    pingCommand,
+  evolutionCommand,
-    evolutionCommand,
+  statsCommand,
-    statsCommand,
+];
-  ] as CommandRegistry[]
+export const commands: Record<string, CommandRegistry> = COMMANDS_RAW.reduce(
-).reduce((accumulator, registry) => {
+  (accumulator, registry) => {
-  if (isDev()) registry.command.setDefaultMemberPermissions(0);
+    if (isDev()) registry.command.setDefaultMemberPermissions(0);
-  return { ...accumulator, [registry.command.name]: registry };
+    return { ...accumulator, [registry.command.name]: registry };
-}, {});
+  },
+  {},
+);
 
 export const guildCommands: RESTPostAPIChatInputApplicationCommandsJSONBody[] =
   [];

src/routes/today.tsx

@@ -5,7 +5,7 @@ import { RouteRegistry } from '../server.js';
 export const todayRoute: RouteRegistry = {
   route: '/today',
   inProduction: true,
-  inDevelopment: true,
+  inDevelopment: false,
 
   async handler(req) {
     const player = resolvePlayerFromRequest(req);

src/stitches.config.ts

@@ -1,10 +1,4 @@
-import {
+import { amberDark, blueDark, slate, slateDark } from '@radix-ui/colors';
-  amberDark,
-  blueDark,
-  slate,
-  slateDark,
-  slateDarkA,
-} from '@radix-ui/colors';
 import { createBorderStyles, createColors } from 'bepaint';
 
 // this isn't really a stitches config, but the object is compliant
@@ -13,8 +7,6 @@ export const theme = {
     ...createColors(slateDark),
     ...createColors(slate, 'light'),
 
-    ...createColors(slateDarkA, 'transparent'),
-
     ...createColors(amberDark, 'amber'),
     ...createColors(blueDark, 'blue'),
   },