https://github.com/slice/snake

Experimental command parser for Discord.js.
https://github.com/slice/snake

Last synced: 3 months ago
JSON representation

Experimental command parser for Discord.js.

• Host: GitHub
• URL: https://github.com/slice/snake
• Owner: slice
• License: mit
• Created: 2017-07-30T03:16:59.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-04T20:21:27.000Z (over 8 years ago)
• Last Synced: 2025-01-21T16:23:56.460Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 102 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# 🐍 snake

![Build status](https://travis-ci.org/slice/snake.svg?branch=master)

Discord.py's command system, but for Discord.js. Based off of [this rejected pull request][rejected-pr].

[rejected-pr]: https://github.com/hydrabolt/discord.js/pull/1485

## Warning!

snake is not feature complete. It is not recommended that you use it for your bots.

## Getting Started

```js

const { CommandClient } = require('discord.js-snake');

let client = new CommandClient({ prefix: '?' });

// Add a command.

client.command('ship', ' ', (ctx, x, y) => {

  ctx.send(`A lovely pairing~ ${x.displayName} ♥️ ${y.displayName}`);

}, 'Ship people.');

// Login!

client.login('...');

```

## Special Thanks

- Gus Caplan (@devsnek)

  - For writing the original code and giving me inspiration.

- Danny (@Rapptz)

  - For writing a kickass command framework that this ended up becoming a copy of.

- Amish Shah (@hydrabolt)

  - Do I really have to explain this one?