discord-trolling
v1.4.2
Published
A discord library simplifying discord.js
Downloads
5
Readme
discord-trolling 👏
An easy to use discord.js wrapper for people who want to make Discord bots quickly
Create a new discord-trolling project:
npx create-discord-trolling-app
Read the docs:
https://ferretcode.gitbook.io/discord-trolling/
Features 📄
- Easy to use, familiar API
- Fast to develop with
- Built in, easy command structuring
- Simple command registration
- Automatic project generator
- Custom CLI
- Documentation
- Simple plugin management
- troll funni
Acknowledgements 💌
Roadmap 🛣️
Big Features
- CLI Daemonization
- Custom templates
- Built-in HTTP or Webhook requests for logging
- ~~Full documentation~~
- Voice wrapper
- Embed maker
- ~~Plugin management~~
- ~~Built-in command handler~~
Low priority
- QOL features
- Improved tests
Not confirmed
- Write Discord API wrapper from scratch
Quickstart 💨
To get started, you can run: npx create-discord-trolling-app
, (recommended)
OR
- Run
npm install discord-trolling
- Create index.js
- Paste these contents inside:
//import components from the library
const {
Client,
Intents,
Manager,
Command,
OptionTypes,
} = require("discord-trolling");
//recommended format for creating command structures
let command = () => {
//create command
let ping = new Command();
ping.setName("ping");
ping.setDescription("ping");
let option = ping.createOption();
option.setName("ping");
option.setRequired(true);
option.setType(OptionTypes.STRING); //you can also do "option.types.STRING"
option.setDescription("ping");
option.setValue("ping");
ping.finalizeOption(option);
//finalize command structure
return ping.troll();
};
//register command
//you can omit guildId if isGuildCommand is set to false
Manager.registerCommands([command()], {
token: "your bot token",
clientId: "your bot id",
guildId: "your guild id",
isGuildCommand: true,
}).catch((err) => console.error(err));
//create client
let bot = new Client({ intents: [Intents.FLAGS.GUILDS] });
//listen for a command
bot.on("interactionCreate", (interaction) => {
if (interaction.commandName === "pong") interaction.reply("pong");
});
//login (trollface)
bot.troll("your bot token");
- Create a new file at commands/ping.js
const { Troll } = require("discord-trolling");
module.exports.ping = class extends Troll {
constructor(interaction, client) {
super(interaction, client);
this.run = () => {
this.interaction.reply("pong!");
};
}
};
Running Tests 🧐
To verify that the library is working, please open test.js and replace the "your bot token", "your bot id" and "your guild id" fields with the respective information, and run the file.
Contributing 💻
Contributions are always welcome and great to see!
You can either:
- Create your contribution, make a PR and hope a maintainer sees it.
- Or join the Discord server at https://discord.gg/cvx9WS7V and propose an idea to me or a maintainer or tell us about a PR you made.
If you are adding a new class, please follow the UpperCamelCase naming convention.