crapcord v1.0.7
crapcord
A small library for making discord bots, using the gateway unlike discord-easy-slash (my last library)
Prerequisites
This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v8.16.0
Getting Started
Installation
BEFORE YOU INSTALL: please read the prerequisites
To install and set up the library, run:
$ npm install crapcord
Or if you prefer using Yarn:
$ yarn add --dev crapcord
Usage
First, Start by importing the library
var client = require('crapcord');
client.login('TOKEN', 513, {
name: "Froggy",
type: client.activityTypes["Playing"],
});
Making a command:
new client.command('help', 1, 'help command?', <APP_ID> ,null) // GLOBAL COMMAND
new client.guild_command('help', 1, 'help command?', <APP_ID> , <GUILD_ID>, null) // GUILD COMMAND
The command class takes 5 arguments, Name (Of the command), Type (Of the command), Description (Of the command), the APP_ID (Of the bot), and Options (any options that the command takes).
The guild_command class takes 6 arguments, Name (Of the command), Type (Of the command), Description (Of the command), the APP_ID (Of the bot), the GUILD_ID (Of the guild), and Options (any options that the command takes).
For types:
or look at this page by discord.
For options:
They look like this:
[ { "name": "nameofoption", "description": "descriptionofoption", "type": 4, "required": true, } ]
It takes an array, with all the options for the command. Because of this, you can have multiple options for a single command.
For types of objects: or look at this page by discord.
Main Event Listener:
client.on('INTERACTION_CREATE', (interaction)=>{
// do stuff
const message = new client.MESSAGE(msg)
message.reply(`Oh, nice message!`)
})
client.on('MESSAGE_CREATE', (msg)=>{
// do stuff
const interact = new client.INTERACTION(msg)
interact.reply(`Oh, nice interaction!`)
})
// and so on...
client.reply takes 3 arguments, message, which is the message to send, embeds, which is an array of embeds for the command to send, and components, which is an array of components for the command to send.
client.reply(message, embeds, components)
For embeds:
[ { "title": "title", "description": "description", "color": "color", "fields": [ { "name": "name", "value": "value", "inline": true }, { "name": "name", "value": "value", "inline": true } ] } ]
Making our bot search for interactions/logging-in/turning it on:
client.login('TOKEN', 513, {
name: "Froggy",
type: client.activityTypes["Playing"],
});
Serving the app
$ npm start
Contributing
You can contribute to the project by making a pull request on GitHub.
Credits
Amukh1.
Built With
Authors
- Amukh1 - Github
See also the list of contributors who participated in this project.
License
MIT License © Amukh1