
QueryBot
QueryBot#4147
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
- Install node.js
- Run the following command:
npm i
Configuration
The project requires a settings.ts file to be created. A settings.example.ts file exists with all the fields required. In order to generate a Discord authToken, follow this tutorial up to step 3.
Run
- Set up up your settings.ts (more information in the configuration section)
- Run
npm start
on a terminal to start the server. - 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 set {keyword} {siteUrl} |
Sets a site keyword. | !qb set yt youtube.com |
!qb unset {keyword} |
Unsets a site keyword. | !qb unset yt |
!qb search {query} !qb s {query} |
Searches for the query on Google. | !qb search discord bots |
!{keyword} {query} |
Searches for the query on the site registered for the passed keyword. | !yt GMM |