GithubHelp home page GithubHelp logo

cryptex-github / js-cord Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jay3332/js-cord

0.0 0.0 0.0 2.45 MB

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

License: MIT License

JavaScript 100.00%

js-cord's Introduction

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:

$ 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:

js-cord's People

Contributors

cats3153 avatar cryptex-github avatar jay3332 avatar mrkomododragon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.