Skip to content

Micro framework to create discord modular bots as fast and as simple as possible, based on discord.js

License

Notifications You must be signed in to change notification settings

tanukijs/discord-bot-base

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Discord Bot Base

NodeICO

DiscordBotBase is an unofficial framework written in TypeScript for discord.js, it allow you to create a discord's bot with the minimum of lines.

Example (minimal)

const { Client } = require('@tanuki/discord-bot-base');

const QueenDecim = new Client({
    token: null,
    ownerId: null,
    prefix: null
});

QueenDecim.logIn()
    .then(() => { console.log('Yo.'); })

See more examples on GitHub.

Features

  • Register a command from file.
    • Options:
      • name - Command name.
      • group - Group of the command.
      • description - A simple description.
      • details - Complete description.
      • ownerOnly - Restrict access to the owner only.
      • args - Array of command's arguments.
        • name - Name of the argument.
        • type - String, Number, Date or other custom type.
        • validator - A checker, must return a [boolean, string].
    • Methods:
      • load - async method executed on command registering.
      • unload - async method executed on command unregistering.
      • run - async method executed when the command has been called.
  • In-built objects sharing across project (including commands) with QueenDecim.shared.
  • In-built commands (enable on-demand).
    • eval - Owner only, execute a code.
    • reload - Owner only, reload a command.
    • help - DM List of registered commands.

If you have any ideas, i am open!

Installation

  1. Our package: npm i --save @tanuki/discord-bot-base
  2. (Optional) Voice support: npm i --save node-opus
  3. (Optional) Faster voice packet encryption/decryption: npm i --save libsodium.js

Links

Contributing

Anyone can contribute to this project with issues and pull requests, i will be happy if you also want to contact me on discord: Tanuki#0003 (Even you're french!).

About

Micro framework to create discord modular bots as fast and as simple as possible, based on discord.js

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published