Skip to content

A simple, modular, configurable discordjs template made as a starting point for bots (WIP)

License

Notifications You must be signed in to change notification settings

dan-online/Neptune

Repository files navigation

Neptune

A template for a discord bot written with discordjs with reloadable events and commands along with a multitude of plugins

Discordjs Version Discord-Bot languages Discord-bot version Neptune CI

Downloads

The master branch is unstable and should be used with caution.

To use stable releases go to releases

To-do

  • Economy / points system plugin
  • Webhook plugin
  • API plugin
  • Updater plugin/system
  • Points system
  • Translate
  • Welcome/Leave messages (image jimp)
  • Verification system (email/oauth)
  • Status page
  • Monitoring app
  • CLI init

Installation

Make sure to have FFmpeg/avconv installed for the youtube plugin

.env

TOKEN=DISCORD_BOT_TOKEN
YANDEX_TOKEN=YANDEX_TOKEN (only if translation API is enabled)

Config

module.exports = {
  prefix: "t!", // bot prefix
  owner: "312551747027468290", // your id
  emojis: {
    // emojis for success and errors
    err: {
      full: ":red_circle:",
      id: ":red_circle:",
    },
    success: {
      id: ":white_check_mark:",
      full: ":white_check_mark:",
    },
  },
  persistent: false, // persistent database or in memory database
};

Install

$ yarn
$ npm

Usage example

$ yarn start
$ npm start

Meta

DanCodes – @dan-onlinedan@dancodes.online

Distributed under the MIT license. See LICENSE for more information.

Contributing

  1. Fork it (https://github.com/dan-online/discord-bot/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request