Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxcord/foxcord
A modern and simple way to interact with the Discord API !
https://github.com/foxcord/foxcord
bot discord discord-api discord-bot discord-js foxcord javascript nodejs npm typescript
Last synced: 2 months ago
JSON representation
A modern and simple way to interact with the Discord API !
- Host: GitHub
- URL: https://github.com/foxcord/foxcord
- Owner: Foxcord
- License: apache-2.0
- Created: 2021-07-02T07:32:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-31T21:16:31.000Z (over 2 years ago)
- Last Synced: 2024-09-24T12:02:51.954Z (3 months ago)
- Topics: bot, discord, discord-api, discord-bot, discord-js, foxcord, javascript, nodejs, npm, typescript
- Language: TypeScript
- Homepage: https://foxcord.xyz/
- Size: 284 KB
- Stars: 44
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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
```js
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
```js
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
```js
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
- [Github](https://github.com/Foxcord/foxcord)
- [NPM](https://www.npmjs.com/package/foxcord)
- [Website](https://foxcord.xyz/)
- [Discord server](https://discord.gg/sTahUmwTsr)
**The documentation is coming very soon, In order to have more information about Foxcord, you can join the [Discord server](https://discord.gg/sTahUmwTsr) !**
# 🔧 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](https://github.com/Foxcord/foxcord/blob/main/.github/CONTRIBUTING.md)
# 🚀 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*
[](https://discord.gg/sTahUmwTsr)
**You can join the Foxcord official Discord server using [this link](https://discord.gg/sTahUmwTsr)**