npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

yuuko

v2.3.4

Published

No-frills Discord command framework for Eris

Downloads

25

Readme

Yuuko

npm version npm@next version Discord support server Donate on Ko-fi

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