https://github.com/crabzzai/botskeleton

Skeleton of a discord.js bot
https://github.com/crabzzai/botskeleton

discord-bot discord-js discord-js-bot discord-js-template discord-js-v13 discordjs discordjs-bot discordjs-template discordjs-v13 discordjsbot mongodb

Last synced: about 1 month ago
JSON representation

Skeleton of a discord.js bot

• Host: GitHub
• URL: https://github.com/crabzzai/botskeleton
• Owner: Crabzzai
• License: mit
• Created: 2022-01-18T21:48:20.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-22T18:51:47.000Z (almost 2 years ago)
• Last Synced: 2024-09-24T12:02:39.438Z (about 2 months ago)
• Topics: discord-bot, discord-js, discord-js-bot, discord-js-template, discord-js-v13, discordjs, discordjs-bot, discordjs-template, discordjs-v13, discordjsbot, mongodb
• Language: JavaScript
• Homepage:
• Size: 25.4 KB
• Stars: 10
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BotSkelet

 Skelet of a discord.js bot

Tired of making the whole "base" of your discord bot? Never been easier!

The following versions was used to test the project:

|                |VERSIONS             |

|----------------|---------------------|

|Discord.js      |`v13.6.0`            |

|Node.js         |`v17.3.0`            |

## How to get started

Install the project with the following command:

```

$ npm install

```

### Events

Get started by duplicating the template named `event.js.structure` and renaming it to a new more convenient name ending on `.js`

The template include the following:

```js

module.exports = (client, config) => {

    var eventObj = {};

    // Settings

    eventObj.name = 'test'; // Event name

    eventObj.once = false; // Set this to true if it should listen once.

    // Main function

    eventObj.execute = () => {

        // Do something in the event here

    }

    return eventObj;

}

```

All event modules should go into the folder named `events`.

### Commands

Get started by duplicating the template named `cmd.js.structure` and renaming it to a new more convenient name ending on `.js`

The template include the following:

```js

// Imports

const Discord = require('discord.js');

const { SlashCommandBuilder } = require('@discordjs/builders');

module.exports = (client, config) => {

    var cmdObj = {};

    // Settings

    cmdObj.name = 'test';

    cmdObj.description = 'test description';

    cmdObj.permissions = null;

    cmdObj.data = new SlashCommandBuilder()

        .setName(cmdObj.name)

        .setDescription(cmdObj.description); // Build properties for a Slash Command here if wanted. If not, set the property to null

    // Main function

    /**

     * @param {Discord.Message} message - Will be set if the command was executed by standard message command.

     * @param {Array || Discord.CommandInteractionOptionResolver} args - If the command was executed by standard message command, it will send an array of string arguments. If executed by slash commands it will return the interaction options.

     * @param {Discord.CommandInteraction} interaction - Will be set if command was executed by a slash command.

     */

    cmdObj.execute = (message, args, interaction) => {}

    return cmdObj;

}

```

This project includes both slash command handling and standard message command handling.

## Finish up

To start the project run the following command:

```

$ npm run start

```

# Important!!

If you experience any problems in your way using this awesome skeleton for your bot, don't hesitate to contact me on discord! `Croixai#2003`