Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jay3332/js-cord
js-cord is a wrapper around the Discord API, written and to be used in Javascript.
https://github.com/jay3332/js-cord
discord javascript js
Last synced: 2 months ago
JSON representation
js-cord is a wrapper around the Discord API, written and to be used in Javascript.
- Host: GitHub
- URL: https://github.com/jay3332/js-cord
- Owner: jay3332
- License: mit
- Created: 2021-03-11T20:01:11.000Z (over 3 years ago)
- Default Branch: rewrite
- Last Pushed: 2021-07-31T16:01:53.000Z (about 3 years ago)
- Last Synced: 2024-07-05T13:58:33.453Z (3 months ago)
- Topics: discord, javascript, js
- Language: JavaScript
- Homepage:
- Size: 2.41 MB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- discord-api-libs - js-cord - js-cord is a wrapper around the Discord API, written and to be used in Javascript. (Libraries / JavaScript)
README
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](#useful-links)
+ [Features](#features)
+ [Installation](#installation)
+ [Examples](#examples)
+ [Ending it off](#ending-it-off)
+ [Credits](#credits)
## Useful Links
+ [Guides](https://github.com/jay3332/js-cord/tree/rewrite/guides)
+ [Repository](https://github.com/jay3332/js-cord)
+ [Documentation](https://jay3332.github.io/js-cord)
+ [Help Server](https://discord.gg/R6pY3FWh3A)
## 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](https://jay3332.github.io/js-cord)
+ 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.
```sh
$ npm install js-cord
```
Or, if you want the latest features, clone this repository directly:
```sh
$ 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
```js
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
```js
// 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](https://discord.gg/R6pY3FWh3A) for help - or consider reading our [docs](https://jay3332.github.io/js-cord/) for reference.
There are also plenty of [guides](https://github.com/jay3332/js-cord/tree/rewrite/guides) on certain topics.
## Credits
#### Contributors
##### Owner:
- [jay3332](https://github.com/jay3332)
##### Contributors:
- [Cats3153](https://github.com/Cats3153)
- [MrKomodoDragon](https://github.com/MrKomodoDragon)