QueryBot

Description

Bot that brings search functionalities to Discord thanks to the Google Search API.

Key Features

• Global search.
• Site search through the use of keywords.
• Excludes NSFW results unless query is run of NSFW channels.

Technologies

• TypeScript is used to write robust code that is later transpiled into JavaScript.
• node.js runs the application.
• Mongoose acts as a middleware to handle data management with MongoDB.
• discord.js handles communication with the Discord API.

Installation

1. Install node.js
2. Run the following command:

npm i

Configuration

The project requires a .env file to be created. A .example.env file exists with all the fields required. In order to generate a Discord authToken, follow this tutorial up to step 3.

Make sure the bot config on the Discord Developer Portal includes the following intents:

• DIRECT_MESSAGES
• GUILDS
• GUILD_MEMBERS
• GUILD_MESSAGES

Run

1. Set up up your settings.ts (more information in the configuration section)
2. Run npm start on a terminal to start the server.
3. If not added already, add you bot to your server following the guide posted in the configuration section up to step 4.

Commands

Syntax	Explanation	Example
!qb about	Displays information about the bot.
!qb help !qb ?	Displays the bot's help.
!qb list !qb ls	Displays all available keywords.
!qb search {query} !qb s {query}	Searches for the query on Google.	!qb search discord bots
!qb set {keyword} {siteUrl}	Sets a site keyword.	!qb set yt youtube.com
!qb stats	Displays bot statistics.
!qb unset {keyword}	Unsets a site keyword.	!qb unset yt
!{keyword} {query}	Searches for the query on the site registered for the passed keyword.	!yt GMM

Links

• Invite QueryBot to your server
• Issues and suggestions

Examples

Global search

Keyword search

TODO

• Replace DB with something less painful to use (firebase, maybe)
• Enable to configure custom prefix by server