# About
Ourcord is a new and alternative Discord library for JS that focuses on speed and simplicity while retaining low level functions of the discord API.
# Table of Contents
# Installation
npm i ourcord
1
That's it for installation 🎈
# Usage
const { Client } = require("ourcord");
const client = new Client("your bot token here");
client.on("ready", () => {
console.log("Client connected!");
});
1
2
3
4
5
6
2
3
4
5
6
View the full documentation here (opens new window).
# Client Config </>
| Option | Type | Default | Description | Optional? |
|---|---|---|---|---|
| browser | string | ourcord | Specify the browser you want to connect via (can be anything) | yes |
| device | string | ourcord | The device you want to connect with (can be anything) | yes |
| prefix | string | null | Specify the prefix for the bot | yes |
| cacheChannels | boolean | false | Whether or not to cache channels | yes |
| cacheGuilds | boolean | false | Whether or not to cache guilds | yes |
| cacheUsers | boolean | false | Whether or not to cache users | yes |
| cacheMembers | boolean | false | Whether or not to cache guild members | yes |
| activity | object | No activity | The activity you want to appear on your client on connect | yes |
| status | string | dnd | The status you want your client to connect with | yes |
| defaultImageFormat | string | null | Default image extension to display. | yes |
| defaultImageSize | number | null | Default image size to display. | yes |