Add a trivia game

.gitignore

@@ -66,3 +66,6 @@ typings/
 
 # dotenv environment variables file
 .env
+
+# trivia lists
+triviaLists/

README.md

@@ -24,6 +24,7 @@ It's planned to have some nifty commands like /assistant which directly communic
 - `/randomword`
 - `/choose`
 - `/reverse`
+- `/trivia`
 - `/8ball`
 - `/repeat`
 - `/calculate`
@@ -83,6 +84,8 @@ It's planned to have some nifty commands like /assistant which directly communic
 
 Set up a MongoDB instance and note its URL. You can set it to store its data in `database` within this folder (you must first make the folder before starting MongoDB)
 
+Get the trivia lists zip from [here](https://siasky.net/nAHYx0Qe7NFag-RuMZTSGizq5ral6Q6m6BZrSHKzzx7r_g) and extract it so that the triviaLists folder is in the top-level directory.
+
 Make a file named `config.json5` in the top-level directory. It should be something like this:
 
 ```json

server/bot/commands/help.ts

@@ -14,6 +14,7 @@ const generalHelp = {
 \`/randomword\` - Returns a random word.
 \`/choose\` - Choose between multiple options.
 \`/reverse\` - Reverse a sentence.
+\`/trivia\` - Start a trivia game on a topic of your choice.
 \`/8ball\` - Random answers to random questions.
 \`/repeat\` - Repeat a string.
 \`/calculate\` - Calculate an expression.

server/bot/commands/trivia.ts

@@ -0,0 +1,268 @@
+import { Message, GuildTextableChannel, TextableChannel, User, EmbedOptions, Client } from 'eris'
+import { Command, DB } from '../imports/types'
+import { getInsult } from '../imports/tools'
+import fs from 'fs'
+
+async function parseTriviaList (fileName: string) {
+  const data = await fs.promises.readFile(`./triviaLists/${fileName}.txt`, 'utf8')
+  const triviaList = new Map<string, string[]>()
+  data.split('\n').forEach(el => {
+    const splitEl = el.split('`').map(ans => ans.trim()).filter(ans => !!ans)
+    if (splitEl.length >= 2) triviaList.set(splitEl[0], splitEl.slice(1))
+  })
+  return triviaList
+}
+
+export class TriviaSession {
+  settings: { maxScore: number, timeout: number, timeLimit: number, botPlays: boolean, revealAnswer: boolean }
+  currentQuestion: [string, string[]]
+  channel: TextableChannel
+  author: User
+  message: Message
+  questionList: Map<string, string[]>
+  scores: { [id: string]: number } = {}
+  stopped = false
+  timer: number = null
+  timeout = Date.now()
+  count = 0
+  tempDB: DB
+  client: Client
+
+  constructor (triviaList: Map<string, string[]>, message: Message, botPlays: boolean, timeLimit: number, maxScore: number, revealAnswer: boolean, tempDB: DB, client: Client) {
+    this.channel = message.channel
+    this.author = message.author
+    this.message = message
+    this.questionList = triviaList
+    this.settings = { maxScore: maxScore, timeout: 120000, timeLimit, botPlays, revealAnswer }
+    this.tempDB = tempDB
+    this.client = client
+  }
+
+  getScores (addMedals = false) {
+    const currentScores = Object.entries(this.scores).sort(([, a], [, b]) => b - a)
+    const medals: { [id: string]: string } = {}
+    if (addMedals) {
+      const maxReduce = (a: number, b: number) => Math.max(a || 0, b || 0)
+      const values = Object.values(this.scores)
+      const first = values.reduce(maxReduce)
+      const second = values.filter(num => num !== first).reduce(maxReduce, 0)
+      const third = values.filter(num => num !== first && num !== second).reduce(maxReduce, 0)
+      currentScores.forEach(([id, b]) => {
+        medals[id] = first && b === first ? '🥇 '
+          : second && b === second ? '🥈 '
+            : third && b === third ? '🥉 ' : ''
+      })
+    }
+    const member = this.message.member.guild.members.get(this.client.user.id)
+    const color = member ? (member.roles.map(i => member.guild.roles.get(i)).sort(
+      (a, b) => a.position > b.position ? -1 : 1
+    ).find(i => i.color !== 0) || { color: 0 }).color : 0
+    const embed: EmbedOptions = {
+      title: 'Scores',
+      color,
+      timestamp: new Date().toISOString(),
+      fields: currentScores.map(player => ({
+        name: (medals[player[0]] || '') + this.message.member.guild.members.get(player[0]).username,
+        value: player[1].toString(),
+        inline: true
+      }))
+    }
+    return { embed }
+  }
+
+  async endGame () {
+    this.stopped = true
+    delete this.tempDB.trivia[this.channel.id]
+    if (Object.keys(this.scores).length > 0) await this.channel.createMessage(this.getScores(true))
+  }
+
+  async newQuestion () {
+    for (let i of Object.values(this.scores)) {
+      if (i === this.settings.maxScore) {
+        await this.endGame()
+        return true
+      }
+    }
+    if (!this.questionList) {
+      await this.endGame()
+      return true
+    }
+    this.currentQuestion = Array.from(this.questionList.entries())[Math.floor(Math.random() * this.questionList.size)]
+    this.questionList.delete(this.currentQuestion[0])
+    this.count += 1
+    this.timer = Date.now()
+    await this.channel.createMessage(`**Question number ${this.count}!**\n\n${this.currentQuestion[0]}`)
+
+    while (this.currentQuestion !== null && (Date.now() - this.timer) <= this.settings.timeLimit) {
+      if (Date.now() - this.timeout >= this.settings.timeout) {
+        await this.channel.createMessage(`If you ${getInsult(true)} aren't going to play then I might as well stop.`)
+        await this.endGame()
+        return true
+      }
+      await new Promise(resolve => setTimeout(resolve, 1000)) // Wait for answer or timeout
+    }
+
+    const revealMessages = ['I know this: ', 'Easy: ', 'Of course, it\'s: ']
+    const failMessages = ['You suck at this', 'That was trivial, really', 'Moving on...']
+
+    if (this.currentQuestion === null) {
+      await new Promise(resolve => setTimeout(resolve, 1000))
+      if (this.stopped === false) await this.newQuestion()
+    } else if (this.stopped) {
+      return true
+    } else {
+      let message: string
+      if (this.settings.revealAnswer) {
+        message = revealMessages[Math.floor(Math.random() * revealMessages.length)] + this.currentQuestion[1][0]
+      } else {
+        message = failMessages[Math.floor(Math.random() * failMessages.length)]
+      }
+      if (this.settings.botPlays) {
+        message += '\n**+1** for me!'
+        if (!this.scores[this.client.user.id]) {
+          this.scores[this.client.user.id] = 1
+        } else {
+          this.scores[this.client.user.id] += 1
+        }
+      }
+      this.currentQuestion = null
+      await this.channel.createMessage(message)
+      await this.channel.sendTyping()
+      await new Promise(resolve => setTimeout(resolve, 1000))
+      if (this.stopped === false) await this.newQuestion()
+    }
+  }
+
+  async checkAnswer (message: Message) {
+    if (message.author.bot || this.currentQuestion === null) {
+      return false
+    }
+    this.timeout = Date.now()
+    let hasGuessed = false
+
+    // TODO: fuse.js for better pattern matching.
+    for (let i = 0; i < this.currentQuestion[1].length; i++) {
+      let answer = this.currentQuestion[1][i].toLowerCase()
+      let guess = message.content.toLowerCase()
+      if (!answer.includes(' ')) { // Strict answer checking for one word answers
+        const guessWords = guess.split(' ')
+        for (let j = 0; j < guessWords.length; j++) {
+          if (guessWords[j] === answer) {
+            hasGuessed = true
+          }
+        }
+      } else if (guess.includes(answer)) { // The answer has spaces, checking isn't as strict
+        hasGuessed = true
+      }
+    }
+
+    if (hasGuessed) {
+      this.currentQuestion = null
+      if (!this.scores[message.author.id]) {
+        this.scores[message.author.id] = 1
+      } else {
+        this.scores[message.author.id] += 1
+      }
+      await this.channel.createMessage(`You got it ${message.author.username}! **+1** to you!`)
+    }
+  }
+}
+
+export const handleTrivia: Command = {
+  name: 'trivia',
+  opts: {
+    description: 'Start a trivia game on a topic of your choice.',
+    fullDescription: `Start a trivia game on a topic of your choice.
+**Default settings:** IveBot gains points: no, seconds to answer: 15, points needed to win: 30, reveal answer on timeout: yes`,
+    usage: `/trivia <topic> (--bot-plays=true|false) (--time-limit=<time longer than 4s>) (--max-score=<points greater than 0>) (--reveal-answer=true|false)
+**During a trivia game:** /trivia (scoreboard/score/scores/stop)
+**To view available topics:** /trivia list`,
+    example: '/trivia greekmyth --bot-plays=true',
+    guildOnly: true,
+    argsRequired: true
+  },
+  generator: async (message: Message, args: string[], { tempDB, client }) => {
+    let botPlays = false
+    let timeLimit = 15000
+    let maxScore = 30
+    let revealAnswer = true
+
+    // TODO: Flag soup can be handled better.
+    if (args.find(element => element.includes('--bot-plays='))) {
+      if (args.find(element => element.includes('--bot-plays=')).split('=')[1] === 'true') {
+        botPlays = true
+      } else if (args.find(element => element === '--bot-plays=').split('=')[1] !== 'false') {
+        return 'Invalid usage. It must be either true or false.'
+      }
+    }
+    if (args.find(element => element.includes('--time-limit='))) {
+      if (+args.find(element => element.includes('--time-limit=')).split('=')[1] > 4) {
+        timeLimit = +args.find(element => element.includes('--time-limit=')).split('=')[1] * 1000
+      } else {
+        return 'Invalid usage. It must be a number greater than 4.'
+      }
+    }
+    if (args.find(element => element.includes('--max-score='))) {
+      if (+args.find(element => element.includes('--max-score=')).split('=')[1] > 0) {
+        maxScore = +args.find(element => element.includes('--max-score')).split('=')[1]
+      } else {
+        return 'Invalid usage. It must be a number greater than 0.'
+      }
+    }
+    if (args.find(element => element.includes('--reveal-answer='))) {
+      if (args.find(element => element.includes('--reveal-answer=')).split('=')[1] === 'false') {
+        revealAnswer = false
+      } else if (args.find(element => element === '--reveal-answer=').split('=')[1] !== 'true') {
+        return 'Invalid usage. It must be either true or false.'
+      }
+    }
+    if (args.length === 1 && ['scores', 'score', 'leaderboard'].includes(args[0])) {
+      const session = tempDB.trivia[message.channel.id]
+      if (session) {
+        return session.getScores()
+      } else {
+        return 'There is no trivia session ongoing in this channel.'
+      }
+    } else if (args.length === 1 && args[0] === 'list') {
+      const lists = await fs.promises.readdir('./triviaLists/')
+      const member = message.member.guild.members.get(client.user.id)
+      const color = member ? (member.roles.map(i => member.guild.roles.get(i)).sort(
+        (a, b) => a.position > b.position ? -1 : 1
+      ).find(i => i.color !== 0) || { color: 0 }).color : 0
+      const embed: EmbedOptions = {
+        title: 'Available trivia lists',
+        color,
+        fields: lists.map(name => ({ name: name.replace('.txt', ''), value: '_ _', inline: true }))
+      }
+      return { embed }
+    } else if (args.length === 1 && args[0] === 'stop') {
+      const session = tempDB.trivia[message.channel.id]
+      const channel = message.channel as GuildTextableChannel
+      if (session) {
+        if (message.author === session.author || channel.permissionsOf(message.author.id).has('manageMessages')) {
+          await session.endGame()
+          return 'Trivia stopped.'
+        } else {
+          return 'You are not authorized to do that.'
+        }
+      } else {
+        return 'There is no trivia session ongoing in this channel.'
+      }
+    } else {
+      const session = tempDB.trivia[message.channel.id]
+      if (!session) {
+        let triviaList
+        try {
+          triviaList = await parseTriviaList(args[0])
+        } catch (err) {
+          return 'That trivia list doesn\'t exist.'
+        }
+        const t = new TriviaSession(triviaList, message, botPlays, timeLimit, maxScore, revealAnswer, tempDB, client)
+        tempDB.trivia[message.channel.id] = t
+        await t.newQuestion()
+      } else {
+        return 'A trivia session is already ongoing in this channel.'
+      }
+    }
+  }
+}

server/bot/imports/tools.ts

@@ -59,12 +59,13 @@ export const getChannel = (message: Message, arg: string) => {
 }
 
 // Fresh insults. They come and go, I suppose.
-export const getInsult = () => {
+export const getInsult = (plural = false) => {
   const insults = [
     'pathetic lifeform', 'ungrateful bastard', 'idiotic slimeball', 'worthless ass', 'dumb dolt',
     'one pronged fork', 'withered oak', 'two pump chump', 'oompa loompa'
   ]
-  return insults[Math.floor(Math.random() * insults.length)]
+  const insult = insults[Math.floor(Math.random() * insults.length)]
+  return plural ? insult.replace('ass', 'asse') + 's' : insult
 }
 
 export const fetchLimited = async (url: string, limit: number, opts = {}): Promise<false | Buffer> => {

server/bot/imports/types.ts

@@ -2,6 +2,7 @@
 import { AdvancedMessageContent, Client, Message } from 'eris'
 import CommandParser from '../client'
 import { Db } from 'mongodb'
+import { TriviaSession } from '../commands/trivia'
 
 export type DB = {
   gunfight: {
@@ -17,6 +18,9 @@ export type DB = {
     // Channels.
     [index: string]: string
   },
+  trivia: {
+    [index: string]: TriviaSession
+  },
   mute: {
     // Servers with userIDs contained.
     [index: string]: string[]

server/bot/index.ts

@@ -104,6 +104,11 @@ export default async (message: Message, client: Client, tempDB: DB, db: Db) => {
   // Content of message and sendResponse.
   const sendResponse = message.channel.createMessage
   const command = message.content.toLowerCase()
+  // Handle answers to trivia
+  const session = tempDB.trivia[message.channel.id]
+  if (session) {
+    await session.checkAnswer(message)
+  }
   // Auto responses and easter eggs.
   if (command.startsWith('is dot a good boy')) await sendResponse('Shame on you. He\'s undefined.')
   else if (command.startsWith('iphone x')) await sendResponse(`You don't deserve it. 😎`)

server/index.ts

@@ -75,6 +75,8 @@ MongoClient.connect(mongoURL === 'dotenv' ? process.env.MONGO_URL : mongoURL, {
         if (!Object.keys(commands).length) return
         // ..register the commands.
         Object.keys(commands).forEach((commandName: string) => {
+          // exclude TriviaSession from commands
+          if (commandName === 'TriviaSession') return
           const command = commands[commandName]
           commandParser.registerCommand(command)
         })
@@ -117,7 +119,7 @@ client.on('error', (err: Error, id: string) => {
 
 // Create a database to handle certain stuff.
 const tempDB: DB = {
-  gunfight: {}, say: {}, link: {}, leave: [], mute: {}, cooldowns: { request: [] }
+  gunfight: {}, say: {}, trivia: {}, link: {}, leave: [], mute: {}, cooldowns: { request: [] }
 }
 
 /* SERVER CODE STARTS HERE */