Foxcord / foxcord

A modern and simple way to interact with the Discord API !

Home Page:https://foxcord.xyz/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Foxcord logo
NPM downloads
Made with Typescript

Foxcord is a modern and simple way to interact with the Discord API !


πŸ”‘ Features

  • Easy to use
  • Latest Discord API version and latest additions
  • Discord support
  • Lightweight

πŸͺ“ Installation

Node.Js v12.0.0 is required at least

$ npm install foxcord
$ yarn add foxcord

πŸ’Ύ Code example

  • Basic code example
const { Client } = require('foxcord');

const client = new Client({
    device: 'MOBILE',
    intents: ['ALL'],
    reconnect: true
});

client.on('READY', () => {
    client.setGame('powered by Foxcord');
    console.log(client.user.tag + ' is online!');
})

client.on('MESSAGE', (message) => {
    if(message.author.bot) return;
    if(message.content === 'ping') return message.channel.send('πŸ“ Pong, my ping is ' + client.ping + 'ms!');
})

client.connect('TOKEN');
  • Registering slash command
const { SlashCommandBuilder, SlashCommandsManager } = require('foxcord');

const slashCommandsManager = new SlashCommandsManager('CLIENT_ID', 'CLIENT_TOKEN');

const coolSlashCommand = new SlashCommandBuilder()
    .setName('cool-command')
    .setDescription('My cool command description');

slashCommandsManager.pushCommand(coolSlashCommand, {
    guildID: 'GUILD_ID' // Optional
});
  • Client using slash commands
const { Client } = require('foxcord');

const client = new Client();

client.on('SLASH_COMMAND_USED', (slashCommand) => {
    slashCommand.reply(slashCommand.member.tag + ' used ' + slashCommand.name, {
        ephemeral: false // Optional, false by default
    });
});

client.connect('TOKEN');

πŸ”— Links

The documentation is coming very soon, In order to have more information about Foxcord, you can join the Discord server !

πŸ”§ Contributing

Before creating an issue, be sure that it has not already been deferred and try to come up with a simple approach to the issue so that deferral is accessible to all.

In order to submit a PR, make sure you have read the contribution guide

πŸš€ Other

Note: The project is in alpha version and still under development, so it is perfectly normal that you have many errors, we advise you to wait for a stable version before using it for your bot.

This project is under Apache-2.0 license

Note: This package is not affiliated with Discord Inc

Discord invite link

You can join the Foxcord official Discord server using this link

About

A modern and simple way to interact with the Discord API !

https://foxcord.xyz/

License:Apache License 2.0


Languages

Language:TypeScript 100.0%