Light

yamdbf / core Goto Github PK

View Code? Open in Web Editor NEW

65.0 5.0 13.0 5.25 MB

The core YAMDBF Framework

Home Page: http://yamdbf.js.org

License: MIT License

JavaScript 0.64% TypeScript 99.36%

yamdbf discord-js discord discord-bot-framework framework typescript bot

core's Introduction

YAMDBF: Yet Another Modular Discord Bot Framework

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
  - MySQL
  - MSSQL
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/core
With the Postgres provider: npm install --save @yamdbf/core pg sequelize
With the SQLite provider: npm install --save @yamdbf/core sqlite3 sequelize
With the MySQL provider: npm install --save @yamdbf/core mysql2 sequelize
With the MSSQL provider: npm install --save @yamdbf/core tedious sequelize

Indev builds can be installed from NPM: npm install --save @yamdbf/core@indev
Documentation for indev builds can be found here.
Indev builds currently require >= Node 14.0.0 to run.

Links

core's People

Contributors

Stargazers

Watchers

Forkers

unforeseenocean nomsi abo-mshari petesimard jump-suit d0cr3d no-realm weeco hichxm jfrux venipa reevadere-codes

core's Issues

This is underated.

Add Command feature: Act as typing until response is sent

It would be nice to have a feature for Command which allows you to set actAsTypingUntilResponseIsSent to true. If you have asynchronous responses to commands, it is handy to inform the user that the bot is processing the request by using message.channel.startTyping(). Once the response has been sent message.channel.stopTyping() has to be executed again.

Implementing that for all commands is a repetitive task and I think this could be a nice feature for this framework.

Cannot find module

Hey, I installed Yamdbf and tried out the example but I get an error message.

Error: Cannot find module 'C:/Programming/Github/Node/Core/node_modules/yamdbf/bin/command/base/Eval.js'

Is this a issue with module or am I doing something wrong?

timeString: always plural

1 secs -> 1 sec.

Guild Storage Not Updating

There was a specific instance of the guild storage not updating.

The series of events that caused this was:

Bot was not running
Bot was removed from one Discord server
Bot was added/registered to a different Discord server
Guild storage did not update to include the new Discord server

Commands Loading

The ability to add logs of which commands are loaded would be nice.

Any examples of using postgres or other providers?

Was trying to use the postgres provider but it's not accepting it...

this._guildDataStorage = new this.provider('guild_storage');

class MyBot extends Client {
	constructor()
	{
		super({
      name: 'MyBot',
      // commandsDir: path.join(__dirname, 'commands'),
      disableBase: excludedBaseClasses,
      token: config.token,
      pause: true,
      provider: "Postgres",
			statusText: 'try @mention help',
			readyText: 'Client is ready!',
			// commandsDir: path.join(__dirname, 'commands')
		});
//...

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.