All Projects → alex-taxiera → eris-boiler

alex-taxiera / eris-boiler

Licence: GPL-3.0 license
A Discord Bot boilerplate using JavaScript and the Eris library

Programming Languages

javascript
184084 projects - #8 most used programming language
shell
77523 projects

Projects that are alternatives of or similar to eris-boiler

zuly
🤖 | Hi, I'm zuly, a brazilian bot! Focused on animes!
Stars: ✭ 45 (+164.71%)
Mutual labels:  eris
ChinoKafuu
🐰 | An incredible bot which can help you in your daily routine in your guild whenever you need it.
Stars: ✭ 55 (+223.53%)
Mutual labels:  eris
FurryBot
Furry Bot for Discord
Stars: ✭ 17 (+0%)
Mutual labels:  eris
eris-fleet
Cluster management for Discord bots using the Eris library.
Stars: ✭ 38 (+123.53%)
Mutual labels:  eris
FelixBot
[This project is Archived] use https://github.com/ParadoxalCorp/felix-production instead
Stars: ✭ 14 (-17.65%)
Mutual labels:  eris
chariot.js
🔮 An extremely lightweight and extensible Eris client framework
Stars: ✭ 25 (+47.06%)
Mutual labels:  eris
Discord-Tools
VSCode extension allowing the integration of a Discord chat, bot templates, snippets, themes and more!
Stars: ✭ 91 (+435.29%)
Mutual labels:  eris
Ritsu
A Discord Bot based on the AnimeMusicQuiz (AMQ) game, play using your MAL/Anilist animelist and with different game modes! ✨
Stars: ✭ 24 (+41.18%)
Mutual labels:  eris
Shoukaku
A featureful stable wrapper for Lavalink
Stars: ✭ 140 (+723.53%)
Mutual labels:  eris
TomokoBot
Hi! I am Tomoko, a Discord Bot for moderation, fun, levels, music and much more!
Stars: ✭ 35 (+105.88%)
Mutual labels:  eris
yuuko
🔰 No-frills Discord command framework for Eris
Stars: ✭ 15 (-11.76%)
Mutual labels:  eris
AwesomeBot
(formerly) The best Discord bot!
Stars: ✭ 25 (+47.06%)
Mutual labels:  eris
Lavacord
A easy to use Lavalink client that can be used with any discord api wrapper
Stars: ✭ 62 (+264.71%)
Mutual labels:  eris
felix-production
Felix v5. bot's actual source code
Stars: ✭ 12 (-29.41%)
Mutual labels:  eris

eris-boiler

discord Build Status Maintainability Test Coverage

A Discord bot framework for JavaScript and the Eris library.

Installation

npm install eris-boiler

Talk to us!

The discord chat is the best place to communicate. We encourage using it for:

  • Asking for help
  • Asking if something is a bug
  • Proposing ideas
  • And anything else you can think of

Documentation

Class documentation can be found here

Usage

// index.js
const { join } = require('path')
const { DataClient } = require('eris-boiler')

/* create DataClient instance */
const options = {
  oratorOptions: {
    defaultPrefix: '!!' // sets the default prefix to !!
  },
  statusManagerOptions: {
    defaultStatus: { // sets default discord activity
      type: 0,
      name: 'a game'
    },
    mode: 'random' // sets activity mode to random, the bot will change status on an interval
  }
}

const bot = new DataClient('YourBotToken', options)

bot
  .addCommands(join(__dirname, 'src/commands')) // load commands in src/commands folder
  .addEvents(join(__dirname, 'src/events')) // load events in src/events folder
  .connect()      
// src/commands/echo.js
const { Command } = require('eris-boiler')

module.exports = new Command({
  name: 'echo', // name of command
  description: 'copy that',
  run: async ({ params }) => params.join(' ') // functionality of command
  // list of things in object passed to run: bot (DataClient), msg (Message), params (String[])
})
// src/events/presenceUpdate.js
const { DiscordEvent } = require('eris-boiler')

module.exports = new DiscordEvent({
  name: 'presenceUpdate', // name should match event name
  run: (bot, newMember, oldMember) => console.log('something changed')
  // bot is bound to all events, so bot will be the first parameter in addition to any parameters passed in from Eris
})

That should cover most things anyone starting out should need to know.

Contributing

Before starting work you should hash it out with us over on discord to make sure it is not already being worked on by someone else.

Check out our guidelines here.

Development

  1. Clone this repository
  2. Run npm install
  3. Add your token and other options
  4. Run npm run dev
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].