Compare commits

...

18 Commits

Author SHA1 Message Date
4ad4f69f9f updated package info 2022-02-01 11:59:34 -06:00
dc0cc6685d typo 2022-01-31 21:20:12 -06:00
c04cd2ef12 i hate windows 2022-01-31 21:18:43 -06:00
763892443d there were some extra newlines 2022-01-31 19:46:09 -06:00
9646d9f941 updated version number and dependencies 2022-01-31 19:35:28 -06:00
fe866050d5 improved messages and general cleanup 2022-01-31 19:33:39 -06:00
00d04c787d added inactivity timeout 2022-01-31 17:47:43 -06:00
f0283145dc added cancel command 2022-01-31 17:39:06 -06:00
50c297bfea removed dev comments 2022-01-31 17:07:59 -06:00
c2c59e53ca updated comments 2022-01-31 17:06:40 -06:00
85d0e833dd cleaned up queue code 2022-01-31 17:06:34 -06:00
1e990abdd5 updated comments 2022-01-31 16:56:47 -06:00
5ce68086b8 updated to es2020 2022-01-31 15:53:23 -06:00
5ee97cfd08 fixed special character bug 2022-01-31 15:50:25 -06:00
5167a25626 added comments 2022-01-31 14:24:29 -06:00
a3a7acf9a8 updated readme 2022-01-31 14:08:33 -06:00
7ae2cb8db0 updated install script 2022-01-31 13:56:39 -06:00
d7adc4afde updated version number 2022-01-31 13:45:40 -06:00
16 changed files with 4122 additions and 3728 deletions

View File

@@ -1,19 +1,41 @@
<!-- markdownlint-disable MD033 -->
# 1800queue
# 1800queue alt
This version does not run continuously, and requires each tourney to be started with a command
## Prerequirements
Download and install [Node.js](https://nodejs.org/en/)
<details>
<summary><b>Your bot's token</b></summary>
<br>
<p>Your bot's token can be found in your <a href="https://discord.com/developers/applications">Discord dev portal</a></p>
<ol>
<li>
Create or choose your application
</li>
<li>
Go to the <code>Bot</code> section
<ul>
<li>
click <code>Add Bot</code> if you haven't already
</li>
</ul>
</li>
<li>
Copy your token
</li>
</ol>
</details>
## Automatic Installation/Updating
1. Download and extract this repository
2. Open the `scripts` folder
3. Open the folder that corresponds with your operating system
4. Run the `install` file
5. Create a file called `token` in the same directory as your `package.json` file and enter your bot client's token
- the `install` script will be updatedd soon to include this step
## Manual Installation/Updating

165
dist/api.js vendored
View File

@@ -18,49 +18,31 @@ var __importStar = (this && this.__importStar) || function (mod) {
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getPlayerInteraction = exports.getPlayer = void 0;
const cheerio = __importStar(require("cheerio"));
const discord_js_1 = require("discord.js");
const https_1 = __importDefault(require("https"));
//making long regex rather than splitting the string at ":" because regex would be easier to debug than logic in the case the website changes
//while names cant have spaces, the name slot in ogtitle could be shown as "No Player Name" which has spaces
const util_1 = require("./util");
const uniteApiRegex = {
//$1 = name, $2 = id
ogtitle: /unite api - ([\w\d ]+) \((.*)\)/i,
//$1 = level, $2 = rank, $3 = elo, $4 = battles, $5 = wins, $6 = win rate
ogdescription: /pokémon unite : lv\.(\d+) (\w+) \((\d+)\)\n battles : (\d+)\n Wins : (\d+)\n win rate : (\d+)%/i,
//for non-masters (no elo)
//ogdescription: /pokémon unite : lv\.(\d+) (\w+): class (\d+) *\n battles : (\d+) *\n wins : (\d+) *\n win rate : (\d+)%/i,
ogtitle: /unite api - (.+) \((.*)\)/i,
//$1 = level, $2 = rank, $3 = elo/class (rest is found by splitting each line)
ogdescription: [
/lv\.(\d+) (\w+) \((\d+)\)/i,
/lv\.(\d+) (\w+): class (\d+)/i //other
]
};
/*
og:title
Unite API - IanWhysp (X188GF7)
og:description
Pokémon Unite : Lv.40 Master (1741)
Battles : 1089
Wins : 576
Win Rate : 52%
*/
/**
* gets the html of the uniteApi page for the player
* @param name name of player
* @returns the html of the page through a promise (rejects if the page status is not 200)
*/
function getHTML(name) {
name = name.replace(/[^\w\d]/g, '');
//name = name.replace(/[^\w\d]/g, '');
return new Promise((resolve, reject) => {
const init = {
host: 'uniteapi.dev',
@@ -73,11 +55,10 @@ function getHTML(name) {
return;
}
let result = Buffer.alloc(0);
response.on('data', function (chunk) {
response.on('data', chunk => {
result = Buffer.concat([result, chunk]);
});
response.on('end', function () {
// result has response body buffer
response.on('end', () => {
resolve(result.toString());
});
};
@@ -89,20 +70,24 @@ function getHTML(name) {
* interprets the html from getHTML()
* @param name name of player
* @returns player data from site
* @throws errorMessage class if the request fails
*/
function readHTML(html) {
let metaElems = cheerio.load(html)('meta').toArray(), foundData = {
let $ = cheerio.load(html);
let metaElems = $('meta').toArray(), foundData = {
name: "",
id: "",
avatar: "",
level: "",
rank: "",
elo: "",
elo: null,
class: null,
battles: "",
wins: "",
winrate: ""
};
//filter down to just ones named "og:..."
metaElems = metaElems.filter(el => { var _a; return (_a = el.attribs.property) === null || _a === void 0 ? void 0 : _a.startsWith('og:'); });
metaElems = metaElems.filter(el => el.attribs.property?.startsWith('og:'));
metaElems.forEach(el => {
let attr = el.attribs;
if (attr.property === 'og:title') {
@@ -113,17 +98,63 @@ function readHTML(html) {
}
}
else if (attr.property === 'og:description') {
let data = uniteApiRegex.ogdescription.exec(attr.content);
if (data !== null && data.length >= 7) {
foundData.level = data[1];
foundData.rank = data[2];
foundData.elo = data[3];
foundData.battles = data[4];
foundData.wins = data[5];
foundData.winrate = data[6];
//all lines
let lines = attr.content.split('\n').map(l => l.trim()), extraLines = [];
//ensure first line is correct
while (lines.length && !/pok.mon unite/i.test(lines[0])) {
let line = lines.shift();
if (line)
extraLines.push(line);
}
if (!lines.length)
throw (0, util_1.emsg)('Unable to read data, please try again');
//bring the first lines removed back into the data
lines = [
...lines,
...extraLines.filter(d => d)
];
//first line
{
//will be only text after "pokemon unite:"
let line = lines[0].split(':').slice(1).join(':').trim();
let regex = uniteApiRegex.ogdescription;
if (regex[0].test(line)) { //is master/has elo
let regexData = line.match(regex[0]);
if (!regexData || regexData.length < 4)
throw (0, util_1.emsg)('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.elo = regexData[3];
}
else { //is not master/has a class
let regexData = line.match(regex[1]);
if (!regexData || regexData.length < 4)
throw (0, util_1.emsg)('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.class = regexData[3];
}
}
lines.shift();
//rest of lines
lines.forEach(line => {
let split = line.split(':').map(l => l.trim()), key = split[0].toLowerCase().replace(/[^\w]/g, ''), value = split[1];
switch (key) {
case 'battles':
foundData.battles = value;
break;
case 'wins':
foundData.wins = value;
break;
case 'winrate':
foundData.winrate = value;
break;
}
});
}
});
foundData.avatar = $('.player-card-image img').attr('src') || "";
foundData.avatar = foundData.avatar.replace('../', 'https://uniteapi.dev/');
return foundData;
}
/**
@@ -141,26 +172,40 @@ function verifyData(data) {
* @param name name of player
* @returns player data
*/
function getPlayer(name) {
return __awaiter(this, void 0, void 0, function* () {
let html = yield getHTML(name);
let data = readHTML(html);
if (verifyData(data))
return data;
return null;
});
async function getPlayer(name) {
let html = await getHTML(name);
let data = readHTML(html);
if (verifyData(data))
return data;
return null;
}
exports.getPlayer = getPlayer;
function getPlayerInteraction(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let username = interaction.options.getString('username', true);
yield interaction.deferReply();
let data = yield getPlayer(username);
if (data === null)
yield interaction.editReply('Unable to find user');
else
yield interaction.editReply('```\n' + JSON.stringify(data, null, 2) + '\n```');
});
async function sendPlayerEmbed(interaction, data) {
let embed = new discord_js_1.MessageEmbed()
.setTitle(`${data.name} (${data.id})`)
.setURL(`https://uniteapi.dev/p/${encodeURIComponent(data.name)}`)
.setTimestamp()
.setThumbnail(data.avatar)
.setDescription(`Level ${data.level}
${data.rank} ${data.elo ? `(${data.elo})` : `Class ${data.class}`}
**Battles** ${data.battles}
**Wins** ${data.wins}
**Win Rate** ${data.winrate}`);
await interaction.editReply({ embeds: [embed] });
}
/**
* calls getPlayer() with the name from the interaction
* @param interaction discord interaction
* @throws errorMessage class if the user cannot be found
*/
async function getPlayerInteraction(interaction) {
let username = interaction.options.getString('username', true);
await interaction.deferReply();
let data = await getPlayer(username);
if (data === null)
throw (0, util_1.emsg)('Unable to find user');
else
sendPlayerEmbed(interaction, data);
}
exports.getPlayerInteraction = getPlayerInteraction;
//await getPlayer('IanWhysp')

49
dist/discord.js vendored
View File

@@ -1,17 +1,9 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.registerCommands = void 0;
const rest_1 = require("@discordjs/rest");
const v9_1 = require("discord-api-types/v9");
// list of commands to register with discord
const commands = [
{
name: 'queue',
@@ -21,7 +13,8 @@ const commands = [
type: 4,
name: 'teamsize',
description: 'size of each team',
required: true
required: true,
min_value: 1
}
]
},
@@ -38,17 +31,17 @@ const commands = [
description: 'ready the queue and display team info'
},
{
name: 'queueinfo',
description: 'get info of the current queue'
name: 'cancel',
description: 'cancels the current queue (must have the Manage Messages permission)'
},
{
name: 'elo',
description: 'display elo information',
name: 'player',
description: 'display player information',
options: [
{
type: 3,
name: 'username',
description: 'in game name',
description: 'in game name or UniteApi short link',
required: true
}
]
@@ -60,20 +53,18 @@ const commands = [
* @param clientId discord bot client id
* @param guildIds discord guild id(s)
*/
function registerCommands(token, clientId, guildIds) {
return __awaiter(this, void 0, void 0, function* () {
const rest = new rest_1.REST({ version: '9' }).setToken(token);
if (typeof guildIds === 'string')
guildIds = [guildIds];
for (let i = 0; i < guildIds.length; i++) {
try {
yield rest.put(v9_1.Routes.applicationGuildCommands(clientId, guildIds[i]), { body: commands });
console.log(`[${guildIds[i]}] registered command`);
}
catch (error) {
console.error(error);
}
async function registerCommands(token, clientId, guildIds) {
const rest = new rest_1.REST({ version: '9' }).setToken(token);
if (typeof guildIds === 'string')
guildIds = [guildIds];
for (let i = 0; i < guildIds.length; i++) {
try {
await rest.put(v9_1.Routes.applicationGuildCommands(clientId, guildIds[i]), { body: commands });
console.log(`[${guildIds[i]}] registered command`);
}
});
catch (error) {
console.error(error);
}
}
}
exports.registerCommands = registerCommands;

42
dist/index.js vendored
View File

@@ -18,59 +18,57 @@ var __importStar = (this && this.__importStar) || function (mod) {
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const discord_js_1 = require("discord.js");
const fs = __importStar(require("fs"));
const api_1 = require("./api");
const discord_1 = require("./discord");
const queue_1 = require("./queue");
const util_1 = require("./util");
const CLIENT = new discord_js_1.Client({ intents: [discord_js_1.Intents.FLAGS.GUILDS] });
//init logs with a timestamp
console.log(new Date().toISOString() + '\n\n');
//get token
if (!fs.existsSync('./token')) {
fs.writeFileSync('./token', '');
console.error('Missing Discord Token, please enter the bot token into the token file');
process.exit(1);
}
const TOKEN = fs.readFileSync('./token').toString();
//discord connections
CLIENT.on('ready', client => {
console.log(`Logged in as ${client.user.tag}`);
client.guilds.fetch().then(guilds => (0, discord_1.registerCommands)(TOKEN, client.user.id, guilds.map(g => g.id)));
});
CLIENT.on('interactionCreate', (interaction) => __awaiter(void 0, void 0, void 0, function* () {
CLIENT.on('interactionCreate', async (interaction) => {
if (!interaction.isCommand())
return;
try {
if (interaction.commandName === 'queue')
yield (0, queue_1.createQueue)(interaction);
await (0, queue_1.createQueue)(interaction);
else if (interaction.commandName === 'join')
yield (0, queue_1.joinQueue)(interaction);
await (0, queue_1.joinQueue)(interaction);
else if (interaction.commandName === 'leave')
yield (0, queue_1.leaveQueue)(interaction);
await (0, queue_1.leaveQueue)(interaction);
else if (interaction.commandName === 'ready')
yield (0, queue_1.readyQueue)(interaction);
else if (interaction.commandName === 'queueinfo')
yield (0, queue_1.queueInfo)(interaction);
else if (interaction.commandName === 'elo')
yield (0, api_1.getPlayerInteraction)(interaction);
await (0, queue_1.readyQueue)(interaction);
else if (interaction.commandName === 'cancel')
await (0, queue_1.cancelQueue)(interaction);
else if (interaction.commandName === 'player')
await (0, api_1.getPlayerInteraction)(interaction);
}
catch (e) {
if (typeof e === 'string') {
if (e instanceof util_1.errorMessage) {
if (interaction.deferred || interaction.replied)
interaction.editReply(e);
interaction.editReply(e.msg);
else
interaction.reply(e);
interaction.reply({
content: e.msg,
ephemeral: e.ephemeral
});
}
else
console.error(e);
}
}));
});
CLIENT.login(TOKEN);

238
dist/queue.js vendored
View File

@@ -1,139 +1,189 @@
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.queueInfo = exports.readyQueue = exports.leaveQueue = exports.joinQueue = exports.createQueue = void 0;
exports.cancelQueue = exports.readyQueue = exports.leaveQueue = exports.joinQueue = exports.createQueue = exports.queueContains = exports.getAll = exports.getInfo = void 0;
const discord_js_1 = require("discord.js");
const util_1 = require("./util");
//maps ChannelID to QueueInfo
const QUEUE = new Map();
/**
* get the GuildMember of an interaction
* @param interaction
* @throws string message if it cannot be read
* @returns member
*/
function getMember(interaction) {
let member = interaction.member;
if (!(member instanceof discord_js_1.GuildMember))
throw 'Unable to retrieve guild member information, please try again';
return member;
}
/**
* get the queueInfo of an interaction
* @param interaction
* @throws string message if it does not exist
* @throws errorMessage class if it does not exist
* @returns queue info
*/
function getInfo(interaction) {
let info = QUEUE.get(interaction.channelId);
if (!info)
throw 'There is not an active queue in this channel, type `/queue` to create one';
throw (0, util_1.emsg)('There is not an active queue in this channel, type `/queue` to create one');
return info;
}
exports.getInfo = getInfo;
/**
* compiles all the get functions above
* @param interaction
* @throws if another get function throws
* @returns object containing each
*/
const getAll = (interaction) => ({
member: (0, util_1.getMember)(interaction),
channel: (0, util_1.getChannel)(interaction),
info: getInfo(interaction)
});
exports.getAll = getAll;
/**
* checks if the interaction data is already in the queue
* @param interaction
* @returns boolean
*/
function queueContains(interaction) {
let { member, info } = (0, exports.getAll)(interaction);
if (info.players.map(m => m.id).includes(member.id))
return true;
return false;
}
exports.queueContains = queueContains;
/**
* creates the timeout for the queue
* @param interaction
* @returns time timeout identifier
*/
function setQueueTimeout(interaction) {
let channel = (0, util_1.getChannel)(interaction);
return setTimeout(() => {
clearQueue(interaction);
channel.send('Queue has been reset due to inactivity');
}, 5 * 60 * 1000); //5 minutes
}
/**
* updates the rich embed for the current queue
* @param interaction
*/
async function sendQueueEmbed(interaction, closed = false) {
let info = getInfo(interaction), origInteraction = info.initiator.interaction;
let embed = new discord_js_1.MessageEmbed()
.setTitle('Queue')
.setAuthor({
name: info.initiator.member.displayName,
iconURL: info.initiator.member.displayAvatarURL({ dynamic: true })
})
.addField('Team Size', info.teamsize.toString(), true)
.addField('Players Joined', info.players.length.toString(), true)
.setFooter({ text: closed ? 'queue is finished' : 'type /join' });
if (origInteraction.deferred || origInteraction.replied)
await origInteraction.editReply({ embeds: [embed] });
else
await origInteraction.reply({ embeds: [embed] });
}
/**
* sends the list of teams
* @param interaction
*/
async function sendTeamsEmbed(interaction, teams) {
let embed = new discord_js_1.MessageEmbed()
.setTitle('Teams');
teams.forEach((team, i) => {
team.map(m => m.user.tag);
embed.addField(`Title ${i + 1}`, team.join('\n'));
});
interaction.reply({ embeds: [embed] });
}
/**
* sends the list of teams
* @param interaction
*/
async function clearQueue(interaction) {
let info = getInfo(interaction);
sendQueueEmbed(interaction, true);
clearTimeout(info.timeout);
QUEUE.delete(interaction.channelId);
}
/**
* creates a queue from an interaction
* @param interaction
* @throws string message if it cannot be created
* @throws errorMessage class if it cannot be created
*/
function createQueue(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let { channelId } = interaction, member = getMember(interaction), teamsize = interaction.options.getInteger('teamsize', true);
if (QUEUE.has(channelId))
throw 'There is already an active queue in this channel, type `/join` to join'; //and you are already in it
QUEUE.set(channelId, {
players: [
member
],
initiator: member,
teamsize: teamsize
});
yield interaction.reply(`Queue for teams of ${teamsize} has been created, and you have joined`);
async function createQueue(interaction) {
let member = (0, util_1.getMember)(interaction), { channelId } = interaction, teamsize = interaction.options.getInteger('teamsize', true);
if (QUEUE.has(channelId))
throw (0, util_1.emsg)('There is already an active queue in this channel, ' + (queueContains(interaction) ? 'and you are already in it' : 'type `/join` to join'));
QUEUE.set(channelId, {
players: [
member
],
initiator: {
interaction,
member
},
teamsize: teamsize,
timeout: setQueueTimeout(interaction)
});
sendQueueEmbed(interaction);
}
exports.createQueue = createQueue;
/**
* joins a queue from an interaction
* @param interaction
* @throws string message if it cannot be joined
* @throws errorMessage class if it cannot be joined
*/
function joinQueue(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let member = getMember(interaction), info = getInfo(interaction);
if (info.players.map(m => m.id).includes(member.id))
throw 'You are already in the active queue';
info.players.push(member);
QUEUE.set(interaction.channelId, info);
yield interaction.reply('Joined the queue');
});
async function joinQueue(interaction) {
let { member, info } = (0, exports.getAll)(interaction);
if (queueContains(interaction))
throw (0, util_1.emsg)('You are already in the active queue');
info.players.push(member);
clearTimeout(info.timeout);
info.timeout = setQueueTimeout(interaction);
QUEUE.set(interaction.channelId, info);
sendQueueEmbed(interaction);
await interaction.reply('Joined the queue');
}
exports.joinQueue = joinQueue;
/**
* leaves a queue from an interaction
* @param interaction
* @throws string message if it cannot be left
* @throws errorMessage class if it cannot be left
*/
function leaveQueue(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let member = getMember(interaction), info = getInfo(interaction);
if (!info.players.map(m => m.id).includes(member.id))
throw 'You aren\'t in the active queue';
info.players.splice(info.players.indexOf(member), 1);
QUEUE.set(interaction.channelId, info);
yield interaction.reply('Left the queue');
});
async function leaveQueue(interaction) {
let { member, info } = (0, exports.getAll)(interaction);
if (!queueContains(interaction))
throw (0, util_1.emsg)('You aren\'t in the active queue');
info.players.splice(info.players.indexOf(member), 1);
clearTimeout(info.timeout);
info.timeout = setQueueTimeout(interaction);
QUEUE.set(interaction.channelId, info);
sendQueueEmbed(interaction);
await interaction.reply('Left the queue');
}
exports.leaveQueue = leaveQueue;
/**
* readys a queue from an interaction
* @param interaction
* @throws string message if it cannot be readied
* @throws errorMessage class if it cannot be readied
*/
function readyQueue(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let member = getMember(interaction), info = getInfo(interaction), { initiator } = info;
if (member.id !== initiator.id)
throw 'Only the queue initiator can ready the queue';
//reset queue
QUEUE.delete(interaction.channelId);
if (info.players.filter(m => m.id !== initiator.id).length === 0)
throw 'Nobody signed up for the queue, the queue has been reset';
//team data
let playerlist = (0, util_1.shuffle)(info.players), teams = [];
//fill team data
for (let i = 0; i < playerlist.length; i += info.teamsize)
teams.push(playerlist.slice(i, i + info.teamsize));
//convert teams to strings
let teamsStr = [];
teams.forEach((team, i) => {
let str = [`Team ${i + 1}`];
team.forEach(m => str.push(` ${m.user.tag}`));
teamsStr.push(str.join('\n'));
});
yield interaction.reply('```\n' + teamsStr.join('\n\n') + '\n```');
});
async function readyQueue(interaction) {
let { member, info } = (0, exports.getAll)(interaction), { initiator } = info;
if (member.id !== initiator.member.id)
throw (0, util_1.emsg)('Only the queue initiator can ready the queue');
clearQueue(interaction);
if (info.players.filter(m => m.id !== initiator.member.id).length === 0)
throw (0, util_1.emsg)('Nobody signed up for the queue, the queue has been reset');
//team data
let playerlist = (0, util_1.shuffle)(info.players), teams = [];
//fill team data
for (let i = 0; i < playerlist.length; i += info.teamsize)
teams.push(playerlist.slice(i, i + info.teamsize));
sendTeamsEmbed(interaction, teams);
}
exports.readyQueue = readyQueue;
/**
* sends the queue information from an interaction
* readys a queue from an interaction
* @param interaction
* @throws string message if it cannot be read
* @throws errorMessage class if it cannot be reset
*/
function queueInfo(interaction) {
return __awaiter(this, void 0, void 0, function* () {
let info = getInfo(interaction);
yield interaction.reply('```' + `
players: ${info.players.map(p => p.user.tag).join('\n ')}
initiator: ${info.initiator.user.tag}
teamsize: ${info.teamsize}
` + '```');
});
async function cancelQueue(interaction) {
let { info, member, channel } = (0, exports.getAll)(interaction);
if (!member.permissionsIn(channel).has('MANAGE_MESSAGES'))
throw (0, util_1.emsg)('You do not have permission to run this command');
clearQueue(interaction);
await interaction.reply('Queue has been reset');
}
exports.queueInfo = queueInfo;
exports.cancelQueue = cancelQueue;

44
dist/util.js vendored
View File

@@ -1,6 +1,7 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.shuffle = void 0;
exports.getChannel = exports.getMember = exports.emsg = exports.errorMessage = exports.shuffle = void 0;
const discord_js_1 = require("discord.js");
/**
* shuffles an array
* https://stackoverflow.com/a/2450976/2856416
@@ -22,3 +23,44 @@ function shuffle(array) {
return array;
}
exports.shuffle = shuffle;
class errorMessage {
constructor(msg, ephemeral = true) {
this.msg = msg;
this.ephemeral = ephemeral;
}
}
exports.errorMessage = errorMessage;
/**
* a simple class to contain an error message and related data
* @param msg error message
* @param ephemeral (default=true)
* @returns new errorMessage
*/
const emsg = (msg, ephemeral = true) => new errorMessage(msg, ephemeral);
exports.emsg = emsg;
/**
* get the GuildMember of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
function getMember(interaction) {
let member = interaction.member;
if (!(member instanceof discord_js_1.GuildMember))
throw (0, exports.emsg)('Unable to retrieve guild member information, please try again');
return member;
}
exports.getMember = getMember;
/**
* get the TextChannel of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
function getChannel(interaction) {
let channel = interaction.channel;
if (!(channel instanceof discord_js_1.TextChannel))
throw (0, exports.emsg)('Unable to retrieve text channel information, please try again');
return channel;
}
exports.getChannel = getChannel;

6776
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "1800queue",
"version": "0.0.1",
"name": "1800queue-alt",
"version": "1.0.0",
"description": "",
"main": "dist/index.js",
"scripts": {

View File

@@ -6,3 +6,13 @@ cd ../..
#run
npm install
#discord token
[ ! -f "token" ] && touch "token"
if [ ! -s "token" ]
then
printf "Enter your discord bot token: "
read token
printf $token > "token"
fi

View File

@@ -3,5 +3,14 @@
@REM change to ccurrent directory
cd %~f0\..\..\..\
@REM discord token
if not exist "token" copy NUL "token"
for /f %%i in ("token") do set size=%%~zi
if %size% equ 0 (
set /p token="Enter your discord bot token: "
echo | set /p=%id% > "token"
)
@REM run
npm install

View File

@@ -1,40 +1,32 @@
import * as cheerio from 'cheerio';
import { CommandInteraction } from 'discord.js';
import { CommandInteraction, MessageEmbed } from 'discord.js';
import { IncomingMessage } from 'http';
import http from 'https';
import { emsg } from './util';
//making long regex rather than splitting the string at ":" because regex would be easier to debug than logic in the case the website changes
//while names cant have spaces, the name slot in ogtitle could be shown as "No Player Name" which has spaces
const uniteApiRegex = {
//$1 = name, $2 = id
ogtitle: /unite api - ([\w\d ]+) \((.*)\)/i,
//$1 = level, $2 = rank, $3 = elo, $4 = battles, $5 = wins, $6 = win rate
ogdescription: /pokémon unite : lv\.(\d+) (\w+) \((\d+)\)\n battles : (\d+)\n Wins : (\d+)\n win rate : (\d+)%/i,
//for non-masters (no elo)
//ogdescription: /pokémon unite : lv\.(\d+) (\w+): class (\d+) *\n battles : (\d+) *\n wins : (\d+) *\n win rate : (\d+)%/i,
ogtitle: /unite api - (.+) \((.*)\)/i,
//$1 = level, $2 = rank, $3 = elo/class (rest is found by splitting each line)
ogdescription: [ //just the first line
/lv\.(\d+) (\w+) \((\d+)\)/i, //master
/lv\.(\d+) (\w+): class (\d+)/i //other
]
}
type uniteApiData = {
name: string,
id: string,
avatar: string,
level: string,
rank: string,
elo: string,
class: string|null,
elo: string|null,
battles: string,
wins: string,
winrate: string
}
/*
og:title
Unite API - IanWhysp (X188GF7)
og:description
Pokémon Unite : Lv.40 Master (1741)
Battles : 1089
Wins : 576
Win Rate : 52%
*/
/**
* gets the html of the uniteApi page for the player
@@ -43,7 +35,7 @@ Pokémon Unite : Lv.40 Master (1741)
*/
function getHTML(name: string): Promise<string> {
name = name.replace(/[^\w\d]/g, '');
//name = name.replace(/[^\w\d]/g, '');
return new Promise((resolve, reject) => {
@@ -61,12 +53,11 @@ function getHTML(name: string): Promise<string> {
}
let result = Buffer.alloc(0);
response.on('data', function(chunk) {
response.on('data', chunk => {
result = Buffer.concat([result, chunk]);
});
response.on('end', function() {
// result has response body buffer
response.on('end', () => {
resolve(result.toString());
});
};
@@ -82,16 +73,20 @@ function getHTML(name: string): Promise<string> {
* interprets the html from getHTML()
* @param name name of player
* @returns player data from site
* @throws errorMessage class if the request fails
*/
function readHTML(html: string): uniteApiData {
let metaElems = cheerio.load(html)('meta').toArray(),
let $ = cheerio.load(html)
let metaElems = $('meta').toArray(),
foundData: uniteApiData = {
name: "",
id: "",
avatar: "",
level: "",
rank: "",
elo: "",
elo: null,
class: null,
battles: "",
wins: "",
winrate: ""
@@ -110,18 +105,89 @@ function readHTML(html: string): uniteApiData {
foundData.id = data[2];
}
} else if (attr.property === 'og:description') {
let data = uniteApiRegex.ogdescription.exec(attr.content);
if (data !== null && data.length >= 7) {
foundData.level = data[1];
foundData.rank = data[2];
foundData.elo = data[3];
foundData.battles = data[4];
foundData.wins = data[5];
foundData.winrate = data[6];
//all lines
let lines = attr.content.split('\n').map(l => l.trim()),
extraLines: string[] = [];
//ensure first line is correct
while (lines.length && !/pok.mon unite/i.test(lines[0])) {
let line = lines.shift();
if (line)
extraLines.push(line);
}
if (!lines.length)
throw emsg('Unable to read data, please try again');
//bring the first lines removed back into the data
lines = [
...lines,
...extraLines.filter(d => d)
];
//first line
{
//will be only text after "pokemon unite:"
let line = lines[0].split(':').slice(1).join(':').trim();
let regex = uniteApiRegex.ogdescription;
if (regex[0].test(line)) { //is master/has elo
let regexData = line.match(regex[0]);
if (!regexData || regexData.length < 4)
throw emsg('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.elo = regexData[3];
} else { //is not master/has a class
let regexData = line.match(regex[1]);
if (!regexData || regexData.length < 4)
throw emsg('Unable to read data, please try again');
foundData.level = regexData[1];
foundData.rank = regexData[2];
foundData.class = regexData[3];
}
}
lines.shift();
//rest of lines
lines.forEach(line => {
let split = line.split(':').map(l => l.trim()),
key = split[0].toLowerCase().replace(/[^\w]/g, ''),
value = split[1];
switch(key) {
case 'battles':
foundData.battles = value;
break;
case 'wins':
foundData.wins = value;
break;
case 'winrate':
foundData.winrate = value;
break;
}
});
}
})
});
foundData.avatar = $('.player-card-image img').attr('src') || "";
foundData.avatar = foundData.avatar.replace('../', 'https://uniteapi.dev/');
return foundData;
@@ -151,15 +217,35 @@ export async function getPlayer(name: string): Promise<uniteApiData|null> {
return null;
}
export async function getPlayerInteraction(interaction: CommandInteraction): Promise<void> {
async function sendPlayerEmbed(interaction: CommandInteraction, data: uniteApiData) {
let embed = new MessageEmbed()
.setTitle(`${data.name} (${data.id})`)
.setURL(`https://uniteapi.dev/p/${encodeURIComponent(data.name)}`)
.setTimestamp()
.setThumbnail(data.avatar)
.setDescription(`Level ${data.level}
${data.rank} ${data.elo ? `(${data.elo})` : `Class ${data.class}`}
**Battles** ${data.battles}
**Wins** ${data.wins}
**Win Rate** ${data.winrate}`);
await interaction.editReply({embeds: [embed]});
}
/**
* calls getPlayer() with the name from the interaction
* @param interaction discord interaction
* @throws errorMessage class if the user cannot be found
*/
export async function getPlayerInteraction(interaction: CommandInteraction) {
let username = interaction.options.getString('username', true);
await interaction.deferReply();
let data = await getPlayer(username);
if (data === null)
await interaction.editReply('Unable to find user');
throw emsg('Unable to find user');
else
await interaction.editReply('```\n'+JSON.stringify(data, null, 2)+'\n```');
sendPlayerEmbed(interaction, data);
}
//await getPlayer('IanWhysp')

View File

@@ -1,6 +1,7 @@
import { REST } from '@discordjs/rest';
import { Routes } from 'discord-api-types/v9';
// list of commands to register with discord
const commands = [
{
name: 'queue',
@@ -10,7 +11,8 @@ const commands = [
type: 4, //INTEGER
name: 'teamsize',
description: 'size of each team',
required: true
required: true,
min_value: 1
}
]
},
@@ -27,17 +29,17 @@ const commands = [
description: 'ready the queue and display team info'
},
{
name: 'queueinfo',
description: 'get info of the current queue'
name: 'cancel',
description: 'cancels the current queue (must have the Manage Messages permission)'
},
{
name: 'elo',
description: 'display elo information',
name: 'player',
description: 'display player information',
options: [
{
type: 3, //STRING
name: 'username',
description: 'in game name',
description: 'in game name or UniteApi short link',
required: true
}
]

View File

@@ -3,11 +3,14 @@ import { Client, Intents } from 'discord.js';
import * as fs from 'fs';
import { getPlayerInteraction } from './api';
import { registerCommands } from './discord';
import { createQueue, joinQueue, leaveQueue, queueInfo, readyQueue } from './queue';
import { cancelQueue, createQueue, joinQueue, leaveQueue, readyQueue } from './queue';
import { errorMessage } from './util';
const CLIENT = new Client({ intents: [Intents.FLAGS.GUILDS] });
//init logs with a timestamp
console.log(new Date().toISOString()+'\n\n');
//get token
if (!fs.existsSync('./token')) {
fs.writeFileSync('./token', '');
console.error('Missing Discord Token, please enter the bot token into the token file');
@@ -15,6 +18,7 @@ if (!fs.existsSync('./token')) {
}
const TOKEN = fs.readFileSync('./token').toString();
//discord connections
CLIENT.on('ready', client => {
console.log(`Logged in as ${client.user.tag}`);
client.guilds.fetch().then(guilds =>
@@ -34,18 +38,23 @@ CLIENT.on('interactionCreate', async interaction => {
await leaveQueue(interaction);
else if (interaction.commandName === 'ready')
await readyQueue(interaction);
else if (interaction.commandName === 'queueinfo')
await queueInfo(interaction);
else if (interaction.commandName === 'elo')
else if (interaction.commandName === 'cancel')
await cancelQueue(interaction);
else if (interaction.commandName === 'player')
await getPlayerInteraction(interaction);
} catch (e) {
if (typeof e === 'string') {
if (e instanceof errorMessage) {
if (interaction.deferred || interaction.replied)
interaction.editReply(e);
interaction.editReply(e.msg);
else
interaction.reply(e);
interaction.reply({
content: e.msg,
ephemeral: e.ephemeral
});
} else console.error(e);
}

View File

@@ -1,89 +1,165 @@
import { info } from "console";
import { CommandInteraction, GuildMember } from "discord.js";
import { shuffle } from "./util";
type queueInfo = {
players: GuildMember[],
initiator: GuildMember,
teamsize: number
}
import { CommandInteraction, GuildMember, MessageEmbed } from "discord.js";
import { emsg, getChannel, getMember, queueInfo, shuffle } from "./util";
//maps ChannelID to QueueInfo
const QUEUE = new Map<string, queueInfo>();
/**
* get the GuildMember of an interaction
* @param interaction
* @throws string message if it cannot be read
* @returns member
*/
function getMember(interaction: CommandInteraction): GuildMember {
let member = interaction.member;
if (!(member instanceof GuildMember))
throw 'Unable to retrieve guild member information, please try again';
return member;
}
/**
* get the queueInfo of an interaction
* @param interaction
* @throws string message if it does not exist
* @throws errorMessage class if it does not exist
* @returns queue info
*/
function getInfo(interaction: CommandInteraction): queueInfo {
export function getInfo(interaction: CommandInteraction): queueInfo {
let info = QUEUE.get(interaction.channelId);
if (!info)
throw 'There is not an active queue in this channel, type `/queue` to create one';
throw emsg('There is not an active queue in this channel, type `/queue` to create one');
return info;
}
/**
* compiles all the get functions above
* @param interaction
* @throws if another get function throws
* @returns object containing each
*/
export const getAll = (interaction: CommandInteraction) => ({
member: getMember(interaction),
channel: getChannel(interaction),
info: getInfo(interaction)
});
/**
* checks if the interaction data is already in the queue
* @param interaction
* @returns boolean
*/
export function queueContains(interaction: CommandInteraction): boolean {
let {member, info} = getAll(interaction);
if (info.players.map(m=>m.id).includes(member.id))
return true;
return false;
}
/**
* creates the timeout for the queue
* @param interaction
* @returns time timeout identifier
*/
function setQueueTimeout(interaction: CommandInteraction) {
let channel = getChannel(interaction);
return setTimeout(() => {
clearQueue(interaction);
channel.send('Queue has been reset due to inactivity');
}, 5*60*1000) //5 minutes
}
/**
* updates the rich embed for the current queue
* @param interaction
*/
async function sendQueueEmbed(interaction: CommandInteraction, closed: boolean = false) {
let info = getInfo(interaction),
origInteraction = info.initiator.interaction;
let embed = new MessageEmbed()
.setTitle('Queue')
.setAuthor({
name: info.initiator.member.displayName,
iconURL: info.initiator.member.displayAvatarURL({dynamic: true})
})
.addField('Team Size', info.teamsize.toString(), true)
.addField('Players Joined', info.players.length.toString(), true)
.setFooter({text: closed ? 'queue is finished' : 'type /join'});
if (origInteraction.deferred || origInteraction.replied)
await origInteraction.editReply({embeds: [embed]});
else
await origInteraction.reply({embeds: [embed]});
}
/**
* sends the list of teams
* @param interaction
*/
async function sendTeamsEmbed(interaction: CommandInteraction, teams: GuildMember[][]) {
let embed = new MessageEmbed()
.setTitle('Teams');
teams.forEach((team, i) => {
team.map(m => m.user.tag);
embed.addField(`Team ${i+1}`, team.join('\n'))
});
interaction.reply({embeds: [embed]});
}
/**
* sends the list of teams
* @param interaction
*/
async function clearQueue(interaction: CommandInteraction) {
let info = getInfo(interaction);
sendQueueEmbed(interaction, true);
clearTimeout(info.timeout);
QUEUE.delete(interaction.channelId);
}
/**
* creates a queue from an interaction
* @param interaction
* @throws string message if it cannot be created
* @throws errorMessage class if it cannot be created
*/
export async function createQueue(interaction: CommandInteraction) {
let {channelId} = interaction,
member = getMember(interaction),
let member = getMember(interaction),
{channelId} = interaction,
teamsize = interaction.options.getInteger('teamsize', true);
if (QUEUE.has(channelId))
throw 'There is already an active queue in this channel, type `/join` to join'; //and you are already in it
throw emsg('There is already an active queue in this channel, ' + (queueContains(interaction) ? 'and you are already in it' : 'type `/join` to join'));
QUEUE.set(channelId, {
players: [
member
],
initiator: member,
teamsize: teamsize
initiator: {
interaction,
member
},
teamsize: teamsize,
timeout: setQueueTimeout(interaction)
});
await interaction.reply(`Queue for teams of ${teamsize} has been created, and you have joined`);
sendQueueEmbed(interaction);
}
/**
* joins a queue from an interaction
* @param interaction
* @throws string message if it cannot be joined
* @throws errorMessage class if it cannot be joined
*/
export async function joinQueue(interaction: CommandInteraction) {
let member = getMember(interaction),
info = getInfo(interaction);
let {member, info} = getAll(interaction);
if (info.players.map(m=>m.id).includes(member.id))
throw 'You are already in the active queue';
if (queueContains(interaction))
throw emsg('You are already in the active queue');
info.players.push(member);
clearTimeout(info.timeout);
info.timeout = setQueueTimeout(interaction)
QUEUE.set(interaction.channelId, info);
sendQueueEmbed(interaction);
await interaction.reply('Joined the queue');
}
@@ -91,20 +167,22 @@ export async function joinQueue(interaction: CommandInteraction) {
/**
* leaves a queue from an interaction
* @param interaction
* @throws string message if it cannot be left
* @throws errorMessage class if it cannot be left
*/
export async function leaveQueue(interaction: CommandInteraction) {
let member = getMember(interaction),
info = getInfo(interaction);
let {member, info} = getAll(interaction);
if (!info.players.map(m=>m.id).includes(member.id))
throw 'You aren\'t in the active queue';
if (!queueContains(interaction))
throw emsg('You aren\'t in the active queue');
info.players.splice(info.players.indexOf(member), 1);
clearTimeout(info.timeout);
info.timeout = setQueueTimeout(interaction)
QUEUE.set(interaction.channelId, info);
sendQueueEmbed(interaction);
await interaction.reply('Left the queue');
}
@@ -112,22 +190,20 @@ export async function leaveQueue(interaction: CommandInteraction) {
/**
* readys a queue from an interaction
* @param interaction
* @throws string message if it cannot be readied
* @throws errorMessage class if it cannot be readied
*/
export async function readyQueue(interaction: CommandInteraction) {
let member = getMember(interaction),
info = getInfo(interaction),
let {member, info} = getAll(interaction),
{initiator} = info;
if (member.id !== initiator.id)
throw 'Only the queue initiator can ready the queue';
if (member.id !== initiator.member.id)
throw emsg('Only the queue initiator can ready the queue');
//reset queue
QUEUE.delete(interaction.channelId);
clearQueue(interaction);
if (info.players.filter(m => m.id !== initiator.id).length === 0)
throw 'Nobody signed up for the queue, the queue has been reset';
if (info.players.filter(m => m.id !== initiator.member.id).length === 0)
throw emsg('Nobody signed up for the queue, the queue has been reset');
//team data
let playerlist: GuildMember[] = shuffle(info.players),
@@ -137,33 +213,24 @@ export async function readyQueue(interaction: CommandInteraction) {
for (let i = 0; i < playerlist.length; i+= info.teamsize)
teams.push(playerlist.slice(i, i+info.teamsize));
//convert teams to strings
let teamsStr: string[] = [];
teams.forEach((team, i) => {
let str = [`Team ${i+1}`];
team.forEach(m => str.push(` ${m.user.tag}`));
teamsStr.push(str.join('\n'));
});
await interaction.reply('```\n'+teamsStr.join('\n\n')+'\n```');
sendTeamsEmbed(interaction, teams);
}
/**
* sends the queue information from an interaction
* readys a queue from an interaction
* @param interaction
* @throws string message if it cannot be read
* @throws errorMessage class if it cannot be reset
*/
export async function queueInfo(interaction: CommandInteraction) {
export async function cancelQueue(interaction: CommandInteraction) {
let info = getInfo(interaction);
let {info, member, channel} = getAll(interaction);
await interaction.reply('```'+`
players: ${info.players.map(p => p.user.tag).join('\n ')}
initiator: ${info.initiator.user.tag}
teamsize: ${info.teamsize}
`+'```');
if (!member.permissionsIn(channel).has('MANAGE_MESSAGES'))
throw emsg('You do not have permission to run this command');
clearQueue(interaction);
await interaction.reply('Queue has been reset');
}

View File

@@ -1,3 +1,4 @@
import { CommandInteraction, GuildMember, TextChannel } from "discord.js";
/**
* shuffles an array
@@ -22,3 +23,65 @@ export function shuffle(array: any[]) {
return array;
}
export class errorMessage {
public msg: string;
public ephemeral: boolean;
constructor(msg: string, ephemeral: boolean = true) {
this.msg = msg;
this.ephemeral = ephemeral;
}
}
/**
* a simple class to contain an error message and related data
* @param msg error message
* @param ephemeral (default=true)
* @returns new errorMessage
*/
export const emsg = (msg: string, ephemeral: boolean = true) => new errorMessage(msg, ephemeral);
export type queueInfo = {
players: GuildMember[],
initiator: {
interaction: CommandInteraction,
member: GuildMember
},
teamsize: number,
timeout: NodeJS.Timeout
}
/**
* get the GuildMember of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
export function getMember(interaction: CommandInteraction): GuildMember {
let member = interaction.member;
if (!(member instanceof GuildMember))
throw emsg('Unable to retrieve guild member information, please try again');
return member;
}
/**
* get the TextChannel of an interaction
* @param interaction
* @throws errorMessage class if it cannot be read
* @returns member
*/
export function getChannel(interaction: CommandInteraction): TextChannel {
let channel = interaction.channel;
if (!(channel instanceof TextChannel))
throw emsg('Unable to retrieve text channel information, please try again');
return channel;
}

View File

@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es2016",
"target": "es2020",
"module": "commonjs",
"rootDir": "./src",
"outDir": "./dist",