yuuko

Yuuko

A no-frills Discord command framework for Eris.

Yuuko's goal is to provide a solid base for Discord bots of all types and sizes, featuring easy support for modular project structures, multiple levels of configuration hooks, and first-class Typescript compatibility in a lightweight package with no extra dependencies. Read the usage guide or check the full API reference.

Note: Due to slow Eris development and low maintainer responsiveness, Yuuko is currently considered in maintenance mode. It will continue to be updated to work with new versions of Eris, but it will probably not get any significant feature updates - including support for slash commands. The author of this project doesn't recommended the use of Eris-based frameworks, including Yuuko, for new projects at this time.

Installation

Yuuko expects Eris to be installed as a peer dependency, which allows you to use any forward-compatible Eris version without having to update Yuuko first. Using npm, you can install both at once with this command:

$ npm install yuuko eris

Generally, the latest version of Eris is the only one actively tested against. You can try older versions, but there's no guarantee they'll work - Yuuko is often updated to take advantage of the latest changes to Eris.

Usage example

const {Client, Command} = require('yuuko');

const mybot = new Client({
  // Token used to auth your bot account
  token: 'your_bot_token',
  // Prefix used to trigger commands
  prefix: '.',
});

const pingCommand = new Command('ping', message => {
  message.channel.createMessage('Pong!');
});

mybot
  .addCommand(pingCommand)
  .connect();

This is all you need to get up and running! Read the usage guide for a walkthrough of Yuuko's most notable features, or check the full API reference.

Development builds

All commits to Yuuko's development branches are automatically built via CI to make installing development versions from Github easy. For example, if you want to get builds from the branch my-new-feature, install Yuuko as eritbh/yuuko#builds/my-new-feature. Remember to grab your Eris version of choice as well.

LICENSE

MIT © eritbh