@jcauman23/ezdiscord

2.0.1 • Public • Published

ezdiscord.js

  • Please keep newest version and stay up to date

Installation

npm i @jcauman23/ezdiscord

  • using the module
    const ezdiscord = require("@jcauman23/ezdiscord")
    const Discord = require("discord.js")
    const allIntents = new Discord.Intents(32767);
    const client = new Discord.Client({ 
      intents: [allIntents] 
    });
    ezdiscord.init(client, {
      handlers: {
        commands: {
          enabled: true,
          subfolders: false,
          folder: "commands"
        },
        events: {
          enabled: true,
          folder: "events"
        },
        messageListener: {
          enabled: true,
          DM: false,
          prefix: "!",
          owners: ["681869871730130962"],
        }
      },
    
      useBuiltInCommands: {
        enabled: true,
        commands: ["reload", "ping"]
      }
    })
    client.login(token)

Help

commands

NOTE: MUST HAVE "folder" DEFINED

listens for commands based on if subfolders is on or not

messageListener

NOTE: MUST HAVE "prefix" DEFINED

listens for messages and creates a messageCreate event for you.

  • command start if messageListener is on
module.exports = {
  name: "name",
  description: "description",
  dirname: __dirname,
  nsfw: false,
  run: async(client, message, args){
    code here
  }
}
  • extras
message.error() - `function that outputs an error code with a custom message`

-- source --
message.error = async function(msg) {
  message.channel.send(":x:  |  "+msg)
}

-- usage --
message.error("This is an error")

-- output -- 
 | This is an error
message.success() - `function that outputs a success message with a custom message`

-- source --
message.success = async function(msg) {
  message.channel.send(":white_check_mark:  |  "+msg)
}

-- usage --
message.error("This is a success message")

-- output --
| This is a success message
-- DM --
Allows the bot to answer dms

events

NOTE: MUST HAVE "folder" DEFINE

listens for events in the folder
  • to define events if events is enabled
  • once ready event
    module.exports = {
     once: true,
     run: async(client) => {
       console.log("ready")
     }
    }
  • non-once event
    module.exports = {
      once: false,
      run: async(client, message) => {
        if(message.author.bot) return
        ...args
      }
    }

useBuiltInCommands

NOTE: THE useMessageListener HAS TO BE ON FOR THIS TO WORK
module.exports = {
  useBuiltInCommands: {
    enabled: true,
    commands: ["reload", "ping"]
  }
}
  • all built in commands: reload, ping

Readme

Keywords

none

Package Sidebar

Install

npm i @jcauman23/ezdiscord

Weekly Downloads

1

Version

2.0.1

License

ISC

Unpacked Size

10.4 kB

Total Files

7

Last publish

Collaborators

  • jcauman23