https://github.com/DanieliusDev/Approxi
A easy to use discord.js framework.
https://github.com/DanieliusDev/Approxi
discord discord-bot discord-js framework typescript typescript-definitions typescript-library
Last synced: 6 months ago
JSON representation
A easy to use discord.js framework.
- Host: GitHub
- URL: https://github.com/DanieliusDev/Approxi
- Owner: DanieliusDev
- License: apache-2.0
- Archived: true
- Created: 2022-03-01T20:08:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-02T17:47:40.000Z (almost 4 years ago)
- Last Synced: 2024-10-19T18:02:13.739Z (over 1 year ago)
- Topics: discord, discord-bot, discord-js, framework, typescript, typescript-definitions, typescript-library
- Language: TypeScript
- Homepage: https://npmjs.com/package/approxi
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Approxi
A easy to use [Discord.js](https://discord.js.org) framework.
> **Not:** This package will no longer be updated.
## About
Approxi is a powerful and easy to use [Discord.js](https://discord.js.org) framework that allows your code to be as minimal as possible.
- Built in typescript.
- Built on top of [Discord.js](https://discord.js.org).
- Supports slash commands.
- Easy configuration.
## Useful links
- [Discord.js documentation](https://discord.js.org/#/docs)
## Getting started
Firstly lets create a `index.js` file and add the following code. This will be your main file for your discord bot.
```js
const { Client } = require('approxi');
// Add configuration.
// If you want to test your bot, consider adding your guild's id in the guilds property.
const config = { commands: { guilds: ['your-guild-id'] } };
// Create a new client and add your config to it.
const client = new Client({ intents: ['GUILDS'] }, config);
// Login to your bot as you would using discord.js.
client.login('discord-bot-token');
```
Now lets create a directory named `commands`, This will be where all your commands will be located.
Inside the `commands` directory, Add a new file named something like `ping.js`, In this guide we will make a ping command.
Inside the file add the following:
```js
const { Command } = require('approxi');
// Create a new command.
module.exports = new Command(
// Add command data.
{ name: 'ping', description: 'The ping command.' },
// Add a function to run when this command is used.
(interaction) => interaction.reply('Pong!')
);
```
After that, Lets make a new directory named `events`, This will be where all your events will be located.
Inside the `events` directory, Add a new file named something like `ready.js`, In this guide we will make a ready event.
Inside the file add the following:
```js
const { Event } = require('approxi');
// Create a new event.
module.exports = new Event(
// Add event data.
{ name: 'ready', once: true },
// Add a function to run when this event is emitted.
(client) => console.log(`Logged in as ${client.user.tag}`)
);
```
Now that we have a command and a event ready, We can now run the `index.js` file!
Congratulations! You have made your very first discord bot using the Approxi framework!
## TODO
- Add documentation.
- Create CLI.