Skip to content

js-cord is a wrapper around the Discord API, written and to be used in Javascript.

License

Notifications You must be signed in to change notification settings

jay3332/js-cord

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

js-cord

js-cord

An API wrapper for Discord, made using JavaScript.


Why js-cord?

I tend to use Python more for developing Discord Bots because the API wrapper for Python (discord.py) has more features than the conventional discord.js. This wrapper fixes that, with built in command handling, pagination, debugging, and so much more.

Table of Contents

Useful Links

Features

It is obvious that this all isn't true. These are what we plan for js-cord to achieve.

  • 100% API coverage
    • Discord interaction support
      • Slash commands, message components
    • Voice send/receive support
    • Easy to use webhook support
  • Extensive documentation
  • Built-in plugins
    • Advanced command handing
      • Easy to implement built-in commands
      • Argument and flag parsing
      • Easy error handling
    • Menus and paginators

Installation

js-cord is still in it's beta stage, therefore installing from NPM will install an older, ineffective version of js-cord.
For now, please install js-cord by cloning this repository.

You can install js-cord using npm:

Currently npm install @jay3332/js-cord until further notice.

$ npm install js-cord

Or, if you want the latest features, clone this repository directly:

$ npm install git+https://github.com/jay3332/js-cord

Examples

In all of these examples, we assume you have already created a bot and have it's token ready.

Basic Bot

const discord = require('js-cord');
const client = new discord.Client();

client.on('ready', () => {
    console.log(`Logged in as ${client.user}`)
});

client.on('message', async (msg) => {
    if (msg.content === 'ping') {
        await msg.reply('Pong!');
    }
});

client.login(process.env.TOKEN);

Built-in command handler

// Can also be accessed via discord.plugins.commands
const { plugins: { commands } } = require('js-cord');
const bot = new commands.Bot({ prefix: '$' });

bot.on('ready', () => {
    console.log(`Logged in as ${bot.user}`);
});

bot.command('ping', async (ctx) => {
    await ctx.reply('Pong!');
});

bot.login(process.env.TOKEN);

Ending it off

You can join our support server for help - or consider reading our docs for reference.

There are also plenty of guides on certain topics.

Credits

Contributors

Owner:
Contributors:

About

js-cord is a wrapper around the Discord API, written and to be used in Javascript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published