@devartsite/DiscordBot

DiscordBot is a node.js module that allows you to build a Discord Bot easily
Easy to use, the important thing is to read our documentation

npm

npm version GitHub package.json version Standard - JavaScript Style Guide GitHub top language GitHub code size in bytes

GitHub repo size Libraries.io dependency status for latest release, scoped npm package npm GitHub commit activity npm collaborators NPM

discord GitHub issues Twitter Follow GitHub followers GitHub stars GitHub watchers GitHub forks

# Installation To install DiscordBot: ``` sh npm i @devartsite/discordbot ``` # Basic example ``` js const DiscordBot = require('@devartsite/discordbot') const client = new DiscordBot({ DiscordBotOptions }) client.login(token) ``` - By default DiscordBot integrates a [Help Module](https://github.com/DevArtSite/DiscordBot/tree/master/modules/Help) ## options - `ggid` - **String** (*global guild id*) Id of the developer’s guild *(default "``null``")* - `gcid` - **String** (*global channel id*) Id of the developer’s channel on developer’s guild *(default "``null``")* - `dev` - **String** Name of the main developer *(default "``Anonymous``")* - `prefix` - **String** Character string to recognize a command of a message *(default "``&``")* - `dbname` - **String** Name of mongo database *(default "``null``")* - `customHelp` - **Object** object containing the title and custom description for the help command - `title` - **String** Title help command *(default "``null``")* - `description` - **String** Description help command *(default "``null``")* - `modulesPath` - **String** Your modules folder path *(default "``null``")* - `useDefaultModule` - **Boolean|Array** Module selection enabled *(default "``['*']``")* # Module implementation ```sh DiscordBot-project ├── modules │ ├── index.js │ ├── commands.js │ ├── methods.js │ ├── responses.js │ └── events.js └── index.js ``` # ToDo - Client: - ✓ Base discord.js - ✓ MongoDb connection - ✓ Initialisation module and start main script - ✓ Message embed default data assignation - Modules - ✓ Check module existance - ✓ Check module components - ✓ Main script - ✓ Commands - ✓ Events - ✓ Methods - ✓ Responses - ✓ Start main script