logan/DRB-CnC
1
0
Fork 0
Code Issues 23 Pull Requests Packages Projects 1 Releases Wiki Activity

Allow the client to interact with the discord bot

Browse Source 
- The client can now interact with the bot, this allows the client to offer bot controls via API
- The master server will now be able to instruct a specific client to join a specific channel via channel ID (master server function coming soon)
- Suppress some debug statements to make the output easier to read when mixed in with the client debug output
This commit is contained in:
Logan Cusano
2022-12-18 20:31:54 -05:00
parent 6756a5e632
commit c8c75e8b37
9 changed files with 236 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
Client/discord-bot/app.js
View File

@@ -13,6 +13,23 @@ import { Client, GatewayIntentBits } from 'discord.js';
// Utilities
import registerCommands from './utilities/registerCommands.js';
/**
* Host Process Object Builder
*
* This constructor is used to easily construct responses to the host process
*/
class HPOB {
/**
* Build an object to be passed to the host process
* @param command The command to that was run ("Status", "Join", "Leave", "ChgPreSet")
* @param response The response from the command that was run
*/
constructor(command = "Status"||"Join"||"Leave"||"ChgPreSet", response) {
this.cmd = command;
this.msg = response;
}
}
// Create the Discord client
const client = new Client({
intents: [
@@ -23,9 +40,59 @@ const client = new Client({
]
});
/**
* When the parent process sends a message, this will interpret the message and act accordingly
*
* DRB IPC Message Structure:
* msg.cmd = The command keyword; Commands covered on the server side
* msg.params = An array containing the parameters for the command
*
*/
process.on('message', (msg) => {
log.DEBUG('IPC Message: ', msg);
const guildID = getGuilds()[0];
log.DEBUG("Guild Name: ", getGuildNameFromID(guildID));
switch (msg.cmd) {
// Check the status of the bot
case "Status":
log.INFO("Status command run from IPC");
status({guildID: guildID, callback: (statusObj) => {
log.DEBUG("Status Object string: ", statusObj);
if (!statusObj.voiceConnection) return process.send(new HPOB("Status", "VDISCONN"));
}});
break;
// Check the params for a server ID and if so join the server
case "Join":
log.INFO("Join command run from IPC");
join({guildID: guildID, guildObj: client.guilds.cache.get(guildID), channelID: msg.params.channelID, callback: () => {
process.send(new HPOB("Join", "AIDS"));
}})
break;
// Check to see if the bot is in a server and if so leave
case "Leave":
log.INFO("Leave command run from IPC");
leave({guildID: guildID, callback: (response) => {
process.send(new HPOB("Leave", response));
}});
break;
default:
// Command doesn't exist
log.INFO("Unknown command run from IPC");
break;
}
})
// When the client is connected and ready
client.on('ready', () =>{
log.INFO(`${client.user.tag} is ready`)
process.send({'msg': "INIT READY"});
});
/*
@@ -43,10 +110,10 @@ client.on('interactionCreate', (interaction) => {
ping(interaction);
break;
case "join":
join(interaction);
join({ interaction: interaction });
break;
case "leave":
leave(interaction);
leave({ interaction: interaction });
break;
case "status":
status({ interaction: interaction });
@@ -63,6 +130,16 @@ function loginBot(){
client.login(getTOKEN());
}
function getGuilds() {
return client.guilds.cache.map(guild => guild.id)
}
function getGuildNameFromID(guildID) {
return client.guilds.cache.map((guild) => {
if (guild.id === guildID) return guild.name;
})[0]
}
function main(){
registerCommands(() => {
loginBot();

37
Client/discord-bot/commands/join.js
View File

@@ -1,4 +1,8 @@
import {joinVoiceChannel} from "@discordjs/voice";
// Debug
import ModuleDebugBuilder from "../utilities/moduleDebugBuilder.js";
const log = new ModuleDebugBuilder("bot", "join");
// Modules
import { joinVoiceChannel, VoiceConnectionStatus } from "@discordjs/voice";
import {replyToInteraction} from "../utilities/messageHandler.js";
import {createAudioInstance} from "../controllers/audioController.js";
import OpusEncoderPkg from "@discordjs/opus";
@@ -11,17 +15,29 @@ const encoder = new OpusEncoder(48000, 2);
* Join the specified voice channel
*
* @param interaction Message interaction from discord
* @param {string||any} guildID The specified Guild ID if this function is run from the client instead of from an interaction in Discord
* @param {string||any} channelID The channel ID to join
* @param guild The guild object to be used to create a voice adapter
* @param {function} callback The callback that will be needed if this function is run with a Guild ID instead of an interaction
*/
export default async function join(interaction){
const voiceChannel = interaction.options.getChannel('voicechannel');
export default async function join({interaction= undefined, guildID= undefined, channelID = undefined, guildObj = undefined, callback = undefined}){
if (interaction){
const voiceChannel = interaction.options.getChannel('voicechannel');
channelID = voiceChannel.id;
guildID = interaction.guildId;
guildObj = interaction.guild;
if (interaction) replyToInteraction(interaction, `Ok, Joining ${voiceChannel.name}`);
}
log.DEBUG("Channel ID: ", channelID)
log.DEBUG("Guild ID: ", guildID)
const voiceConnection = joinVoiceChannel({
channelId: voiceChannel.id,
guildId: interaction.guildId,
adapterCreator: interaction.guild.voiceAdapterCreator,
channelId: channelID,
guildId: guildID,
adapterCreator: guildObj.voiceAdapterCreator,
selfMute: false,
selfDeaf: false,
});
replyToInteraction(interaction, `Ok, Joining ${voiceChannel.name}`);
const audioInstance = createAudioInstance();
@@ -32,5 +48,12 @@ export default async function join(interaction){
voiceConnection.playOpusPacket(encoded);
})
// Exit the audio handler when the bot disconnects
voiceConnection.on(VoiceConnectionStatus.Destroyed, () => {
audioInstance.quit();
})
audioInstance.start();
if (guildID && callback) callback();
}

23
Client/discord-bot/commands/leave.js
View File

@@ -8,11 +8,24 @@ import {replyToInteraction} from "../utilities/messageHandler.js";
* If in a voice channel for the specified guild, leave
*
* @param interaction Message interaction from discord
* @param guildID
* @param callback
*/
export default async function leave(interaction){
const guildId = interaction.guild.id;
const voiceConnection = getVoiceConnection(guildId);
if (!voiceConnection) return replyToInteraction(interaction, "Not in a voice channel.");
export default async function leave({interaction = undefined, guildID= undefined, callback = undefined}) {
if(interaction) {
guildID = interaction.guild.id;
}
const voiceConnection = getVoiceConnection(guildID);
let response;
if (!voiceConnection){
response = "Not in a voice channel."
if (interaction) return replyToInteraction(interaction, response);
else callback(response);
}
voiceConnection.destroy();
return replyToInteraction(interaction, `Goodbye`);
response = "Goodbye"
if (interaction) return replyToInteraction(interaction, response);
else callback(response);
}

11
Client/discord-bot/commands/status.js
View File

@@ -7,15 +7,18 @@ import {getVoiceConnection} from "@discordjs/voice";
import { replyToInteraction } from '../utilities/messageHandler.js';
export default async function status({interaction= undefined, guildID= undefined}) {
export default async function status({interaction= undefined, guildID= undefined, callback = undefined}) {
//if (!interaction && !guildID) // Need error of sorts
if (interaction){
guildID = interaction.guild.id;
}
const voiceConnection = getVoiceConnection(guildID);
log.DEBUG("guildID: ", guildID)
log.DEBUG("Voice Connection: ", voiceConnection)
const statusObj = {
"guildID": guildID, "voiceConnection": voiceConnection
}
//log.DEBUG('Status Object: ', statusObj);
// get the status and return it accordingly (message reply / module)
@@ -23,6 +26,6 @@ export default async function status({interaction= undefined, guildID= undefined
return replyToInteraction(interaction, "Pong! I have Aids and now you do too!");
}
else {
callback(statusObj);
}
}

2
Client/discord-bot/controllers/audioController.js
View File

@@ -35,7 +35,7 @@ export function getAudioDevices(){
return null;
}
}).filter(Boolean);
log.DEBUG("Device List: ", deviceList);
//log.DEBUG("Device List: ", deviceList);
return deviceList;
}

10
Client/discord-bot/utilities/configHandler.js
View File

@@ -1,10 +1,12 @@
import { readFileSync } from 'fs';
// Debug
import ModuleDebugBuilder from "./moduleDebugBuilder.js";
const log = new ModuleDebugBuilder("bot", "configHandler");
// Modules
import { readFileSync } from 'fs';
import path from "path";
export function getConfig() {
return JSON.parse(readFileSync("./config/botConfig.json"));
return JSON.parse(readFileSync(path.resolve("discord-bot/config/botConfig.json")));
}
export function getTOKEN() {
@@ -17,7 +19,7 @@ export function getTOKEN() {
export function getGuildID() {
const parsedJSON = getConfig();
const guildID = BigInt(parsedJSON.GuildID);
const guildID = parsedJSON.GuildID;
log.DEBUG("Guild ID: ", guildID);
return guildID;
@@ -25,7 +27,7 @@ export function getGuildID() {
export function getApplicationID() {
const parsedJSON = getConfig();
const appID = BigInt(parsedJSON.ApplicationID);
const appID = parsedJSON.ApplicationID;
log.DEBUG("Application ID: ", appID);
return appID;