Coder Social home page Coder Social logo

petesimard / yamdbf Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yamdbf/core

0.0 2.0 0.0 2.92 MB

A Discord.js-based Discord Bot framework to be used as a base for quick bot development

License: MIT License

JavaScript 1.14% TypeScript 98.86%

yamdbf's Introduction

YAMDBF: Yet Another Modular Discord Bot Framework

Discord npm David David Travis

NPM

YAMDBF is a lightweight Discord Bot framework for rapid bot development using Discord.js, making it simple to get a bot up and running with minimal effort and configuration.

Features

  • Fully localizable (English by default)
  • Base commands for control over default settings
  • Full control over all base commands via disabling or overloading
  • Simple structure for creation of custom commands
  • Automatic custom command loading
  • Fine control of command execution per-user/globally via configurable ratelimits
  • Robust middleware system for fine control of execution flow and
    control over the data passed to your commands
    • Ships with methods for resolving different data types and ensuring
      certain args/types are passed to commands
  • Easy to use storage with support for custom storage providers
    • Ships with a default JSON provider, and other optional providers using Sequelize:
      • Postgres
      • SQLite
  • Easy to use Plugin system
  • Full TypeScript support (It's written in it!)
    • Support for decorators for simpler handling of:
      • Event listeners
      • Command metadata
      • Command middleware assignment
      • Attaching Logger for logging/debugging

Installation

Ignore any warnings about unmet peer dependencies as they are all optional unless using a Sequelize-based storage provider.

Note: YAMDBF Requires > Node 8.0.0 to run

  • Regular install: npm install --save yamdbf
  • With a Postgres provider: npm install --save yamdbf pg sequelize
  • With an SQLite provider: npm install --save yamdbf sqlite3 sequelize

Indev builds can be installed from github with npm install --save zajrik/yamdbf. This requires git to be installed and in your path. NPM 5.3.0 is broken for installing dev builds as they have to compile after installation and the compilation script will fail on NPM 5.3.0. To be safe, use NPM 5.0.3 via npm install -g [email protected]

Documentation for indev builds can be found here.

Links

yamdbf's People

Contributors

motiond3v avatar spaceeec avatar zajrik avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.