silver-npm
Version:
208 lines (156 loc) • 7.39 kB
Markdown
# silver-npm
[silver-npm](https://www.npmjs.com/package/silver-npm) is a npm package made by (Silver_3#6333) because i was bored
[【Github】](https://github.com/SilverGamez/silver-npm)
[【Npm】](https://www.npmjs.com/package/silver-npm)
[【Node.js】](https://nodejs.org/en/download/)
## Installation
```bash
npm install silver-npm
```
## Usage
```javascript
const Silver = require('silver-npm');
```
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
# .registerSlashCommands()
#### In this function, it will register the slash commands to the provided guilds with provided commands
#### A example of usage is below
### index.js
```javascript
//this is used to register slash commands
const Silver = require('silver-npm'); //require the package
const fs = require('fs'); //we will need fs (npm i fs)
const Discord = require('discord.js'); //discord.js v13 need to be installed (npm i discord.js)
const client = new Discord.Client({intents: ["GUILDS", "GUILD_INTEGRATIONS"]});
client.commands = new Discord.Collection(); //create a collection to store the commands
const files = fs.readdirSync('./commands').filter(file => file.endsWith(".js")); //only use files that ends with .js
for (const file of files) {
const command = require(`./commands/${file}`); //file to commands folder
client.commands.set(command.data.name, command); //add the command to the collection
}
client.on('ready', () => {
console.log('Bot online'); //when the bot is ready
client.guilds.cache.forEach(guild => {
require('./load-commands')(guild.id) //load slash commands for the guild
});
});
client.on('interactionCreate', (interaction) => {
if(!interaction.isCommand()) return;
const { commandName } = interaction;
const command = client.commands.get(commandName); //get the command from the collection
if(command){ //if the command exists
command.run(interaction, client); //run the command
}
});
client.login('TOKEN'); //login to your bot
```
### load-commands.js
```javascript
const Silver = require('silver-npm');
const fs = require('fs');
module.exports = async (guildID) => {
const commands = [];
const files = fs.readdirSync('./commands').filter(file => file.endsWith(".js"));
for (const file of files) {
const command = require(`./commands/${file}`);
commands.push(command.data.toJSON()) //adds the data to an array
}
const config = {
guildID: guildID, //got from the index.js client.guilds.cache.forEach
clientID: "CLIENT ID", //the clients id, right click the bot and click "copy id"
token: "TOKEN", //bots token
commands: commands
};
Silver.registerSlashCommands(config); //registers the commands
}
```
### commands/ping.js
```javascript
const { SlashCommandBuilder } = require('@discordjs/builders'); //require the slash command builder
module.exports = {
run: async (interaction, client) => {
interaction.reply("Pong!"); //replies with "Pong!"
},
data: new SlashCommandBuilder()
.setName("ping") //name of the command
.setDescription("Pong!") //description of the command
}
```
### What is should look like:
### Output:
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
# .chatBot()
#### In this function, the bot will be a chatbot pretty much
### index.js
```javascript
const Silver = require('silver-npm'); //require the package
const Discord = require('discord.js'); //also need discord
const client = new Discord.Client({intents: ["GUILDS", "GUILD_MESSAGES"]});
client.on('ready', () => {
console.log('Bot is online!'); //when the bot is online
});
client.on('messageCreate', (message) => {
Silver.chatBot(message, CHANNEL_ID); //chat bot
});
client.login('TOKEN'); //login into the bot
```
### Output:
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
# .buttonHelp()
#### In this function, the bot will make a help menu with buttons
### index.js
```javascript
const Silver = require('silver-npm'); //require the package
const Discord = require('discord.js'); //also need discord for embeds
const client = new Discord.Client({
intents: ["GUILDS", "GUILD_MESSAGES"]
});
client.on('ready', () => {
console.log('Bot is online'); //when bot is online
});
client.on('messageCreate', (message) => {
if (message.content == "!help") {
const embed1 = new Discord.MessageEmbed()
.setTitle('Page 1')
.setColor('RANDOM')
const embed2 = new Discord.MessageEmbed()
.setTitle('Page 2')
.setColor('RANDOM')
const embed3 = new Discord.MessageEmbed()
.setTitle('Page 3')
.setColor('RANDOM')
Silver.buttonHelp(message.channel, [embed1, embed2, embed3], '▶', '◀');
// Slver.buttonHelp(channel, array-of-embeds, next, back)
}
});
client.login('TOKEN');
```
### Output:
[Video](https://cdn.discordapp.com/attachments/884277461926428722/891917757216620554/Desktop_2021.09.27_-_15.20.53.01.mp4)
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
# .transcript()
#### In this function, the bot will make a transcript of the channel
### index.js
```javascript
const Silver = require('silver-npm'); //require the package
const Discord = require('discord.js'); //also require discord.js
const client = new Discord.Client({
intents: ["GUILDS", "GUILD_MESSAGES"]
});
client.on('ready', () => {
console.log('Bot is online'); //when bot is online
});
client.on('messageCreate', (message) => {
if (message.content == "!transcript") {
Silver.transcript(message.channel); //create the transcript
}
});
client.login('TOKEN');
```
### Output:
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔