Merge pull request #1 from MonashDeepNeuron/dev

Dev

Author: Aeth3ra

README.md

@@ -1,3 +1,27 @@
 # discord-bot
 Discord bot for MDN discord server.
-Requires node v18+, run npm install to get required modules
+Requires node v18+, run `npm install` to get required modules.
+
+Run `node ./index.js` to start the application.
+
+If a slash command is added/removed or any command **data** is modified (i.e. name, description, parameters), then run `node ./deploy_commands.js` to sync this information with the development server on Discord. Use the `-global` flag to deploy these commands globally (to every Discord server the bot is in).
+
+## Config File
+The bot will need a *config.json* file in the root of the folder, in the following form:
+```json
+{
+    "token": "insert-token-here",
+    "clientId": "insert-client-id",
+    "guildId": "insert-guild-id"
+}
+```
+See [Configuration files](https://discordjs.guide/creating-your-bot/#configuration-files) for information on getting the Bot **token**. 
+Also see [Guild commands](https://discordjs.guide/creating-your-bot/command-deployment.html#guild-commands) for where to find the **clientId** and **guildId**, where the guild is the development server of the bot.
+
+## Bot Permissions
+The bot will require the `bot` and `application.commands` scopes to function properly (see [here](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#creating-and-using-your-invite-link) for more info), as well as the following permissions in the Discord server:
+- Manage Channels
+- Manage Roles
+- Manage Nicknames
+- Mention Everyone
+- Use Application Commands

commands/utility/archive-channel.js

@@ -0,0 +1,44 @@
+const { SlashCommandBuilder, PermissionFlagsBits, PermissionsBitField } = require('discord.js');
+const { archiveId, clientId } = require('../../config.json')
+
+module.exports = {
+    data: new SlashCommandBuilder()
+        .setName('archive-channel')
+        .setDescription('Archives a channel')
+        .setDefaultMemberPermissions(PermissionFlagsBits.ManageChannels)
+        
+        // Get the channel
+        .addChannelOption(option => 
+        option.setName('channel')
+            .setDescription('Channel to archive')
+            .setRequired(true)),
+
+
+    async execute(interaction) {
+        const channel = interaction.options.getChannel('channel');
+        
+        try {
+            // Update permissions to only allow bot to see
+            await channel.permissionOverwrites.set([
+                {
+                    id: interaction.guild.id,
+                    deny: [PermissionsBitField.Flags.ViewChannel],
+                },
+                {
+                    id: clientId,
+                    allow: [PermissionsBitField.Flags.ViewChannel],
+                }
+            ]);
+
+            await channel.setParent(archiveId); // Move channel
+            // Remove bot's permissions
+            // await channel.permissionOverwrites.edit(clientId, { ViewChannel: false });
+            
+            await interaction.reply(`<#${channel.id}> was archived successfully`);
+
+        } catch (error) {
+            console.error(error);
+        	await interaction.reply( {content: 'There was an error archiving this channel.', ephemeral: true } );
+        }
+    }
+}

commands/utility/start-project.js

@@ -0,0 +1,76 @@
+const { SlashCommandBuilder, PermissionFlagsBits, ChannelType, PermissionsBitField } = require("discord.js");
+
+module.exports = {
+    data: new SlashCommandBuilder()
+        .setName('start-project')
+        .setDescription('Create a new channel and role for a project.')
+        .setDefaultMemberPermissions(PermissionFlagsBits.ManageChannels | PermissionFlagsBits.ManageRoles) 
+        
+        // Get the channel name
+        .addStringOption(option =>
+        option.setName('project-name')
+            .setDescription('Name of the new channel')
+            .setRequired(true)
+            .setMaxLength(30) // Max channel name length that can be displayed
+        )
+        
+        // Get the colour of the role
+        .addStringOption(option => 
+        option.setName('colour')
+            .setDescription('Hex color code (e.g: #3E99C6) for the role')
+            .setRequired(false)
+            .setMinLength(7)
+            .setMaxLength(7)
+        ),
+
+    async execute(interaction) {
+        // Get user arguments
+        const name = interaction.options.getString('project-name');
+        const color = interaction.options.getString('colour') ?? '#FFFFFF';
+        const guild = interaction.guild;
+
+        // Validate color input using regular expression
+        if (!/^#([0-9A-F]{3}){1,2}$/i.test(color)) {
+            return interaction.reply({ content: 'Invalid colour code. Please provide a valid hex colour code (e.g., #FF5733).', ephemeral: true });
+        }
+
+        try {
+            // Create role
+            const createdRole = await guild.roles.create({
+                name, 
+                permissions: [PermissionsBitField.Flags.SendMessages],
+                mentionable: true,
+                color,
+            })
+
+            // Create object with channel data
+            const newChannel = {
+                name, 
+                type: ChannelType.GuildText,
+                permissionOverwrites: [
+                    {
+                        id: guild.id,
+                        deny: [PermissionsBitField.Flags.ViewChannel],
+                    },
+                    {
+                        id: createdRole.id,
+                        allow: [PermissionsBitField.Flags.ViewChannel],
+                    }
+                ],
+            };
+
+            // Create the channel
+            const createdChannel = !interaction.channel.parent ?
+                await interaction.guild.channels.create(newChannel) : // If command was run in a stray channel
+                await interaction.channel.parent.children.create(newChannel); // Otherwise create the channel in the same category
+
+            await interaction.reply(`The project **${name}** has been created, ` + 
+                                    `with private channel <#${createdChannel.id}> ` +
+                                    `and role <@&${createdRole.id}>!`);
+            
+        } catch(error) {
+            console.error(error);
+        	await interaction.reply( {content: 'There was an error creating this project.', ephemeral: true } );
+      	}
+    }
+}

deploy_commands.js

@@ -3,12 +3,19 @@ const { clientId, guildId, token } = require('./config.json');
 const fs = require('node:fs');
 const path = require('node:path');
 
+// Check for flags
+const global = process.argv.includes('-global');
+const testing = process.argv.includes('-testing')
+
 const commands = [];
 // Grab all the command folders from the commands directory
 const foldersPath = path.join(__dirname, 'commands');
 const commandFolders = fs.readdirSync(foldersPath);
 
 for (const folder of commandFolders) {
+	// Don't deploy the commands in 'testing/' if -testing flag isn't used
+	if (!testing && folder === 'testing') continue;
+
 	// Grab all the command files from the commands directory
 	const commandsPath = path.join(foldersPath, folder);
 	const commandFiles = fs.readdirSync(commandsPath).filter(file => file.endsWith('.js'));
@@ -34,8 +41,8 @@ const rest = new REST().setToken(token);
 
 		// The put method is used to fully refresh all commands in the guild with the current set
 		const data = await rest.put(
-			Routes.applicationGuildCommands(clientId, guildId),
-            // change above to Routes.applicationCommands(clientId) to make commands global
+			// Deploy commands either to globally or to dev server
+			global ? Routes.applicationCommands(clientId) : Routes.applicationGuildCommands(clientId, guildId),
 			{ body: commands },
 		);