Skip to content

locus-solutions/locus-helper

Repository files navigation

Logo

Multi-purpose discord bot
Found a bug?

Notes

  • There are some modules missing, due to this there's some things that may not be used, and some features might be sloppy, all of this will be redone
  • If you would like to contribute to the missing modules, contact me through one of these options
  • If you'd like to be notified when the modules are completed, click the "Watch" button on the top right

Setup

  • Install NodeJS
  • Install Yarn
  • Clone the repository
  • Change configuration values in config.json
  • Open the cloned repository on your machine in a shell and write yarn to install dependencies
  • Start the bot with node .

Command Example

// Import Modules
const { MessageEmbed } = require('discord.js');

module.exports = {
    name: "",
    category: "",
    description: "",
    aliases: [""],
    usage: "",
    run: async(client, message, args, util) => {
        const embed = new MessageEmbed()

        await message.channel.send({
            embeds: [embed]
        });
    }
}

Util Examples

const util = require('../../utils/util.js');

// randomArray
const array = ["1", "2", "3", "4"]
console.log(util.randomizeArray(array))

// packageJson
console.log(util.packageJson.version)

// randomizeNumber
console.log(util.randomizeNumber(10, 100))

// quickEmbed
return util.quickEmbed(client, message, "There was an error, please try again", client.colors.red)

Guidelines

  • Use Yarn
  • Use Prettier before committing code
  • Test your changes locally before committing code

License

Locus Helper is distributed under the Apache License 2.0

Credits

Contact Me: