dsc-functions
TypeScript icon, indicating that this package has built-in type declarations

1.4.0 • Public • Published

Dsc.best Functions npm

Manage the dsc.best events easily

Package migrated to TypeScript

Support

If you need help with the package or have any question you can join our support server

Table of Contents

Node.js v16 is required

Webhooks

Send a message (or embed) when someone votes for your bot

Prerequisites

Before you configure the package you need to do 3 things:

  1. Have your bot listed in dsc.best
  2. Install and setup the express and discord.js packages
  3. Add the endpoint url in your bot's panel (https://dsc.best/dashboard/bot/YOUR-BOT-ID-HERE) of dsc.best

Picture Example

Setup

npm install dsc-functions --save
const { DscClient } = require('dsc-functions') // import the package
const dscClient = new DscClient({  DiscordClient:  discordClient,  DscAPIToken:  'API-TOKEN-HERE'  })

In your main file

const Discord = require('discord.js');
const Client = new Discord.Client({
	intents: [Discord.Intents.FLAGS.GUILDS, 
	Discord.Intents.FLAGS.GUILD_MESSAGES] //Only add intents if you work in v13
})

const express = require('express')
const app = express()

app.use(express.json())
app.use(express.urlencoded({ extended: false }))

client.on('ready', () => {
	console.log('Online!')
})

app.post('/endpointname', (req, res) => {
	const info = dscClient.webhooks(req)
	
	const webhookEmbed = new Discord.MessageEmbed()
	.setDescription(`${info.eventData.user.username} has voted, and now i have ${info.eventData.votes} votes`)
	
	info.sendWebhook(webhookEmbed, {
		channelId: '856544223801245736', // Here goes the id the channel where you want to send the embed
		reaction: '💟', // Reaction not required (reaction must be a reaction unicode), support animated, normal and custom emojis
		discordJSVersion: 'v13' //We support v12 too (if you are a v13 user this line is optional)
	})
})

app.listen(3000, console.log('Server listening on port 3000'))
Client.login('YOUR-BOT-TOKEN-HERE')

Data you can request of Webhooks

  • Verification
  • Event type
  • Username
  • Discriminator
  • User ID
  • User Avatar
  • Total Votes of your bot

Post Server Count

Post the server count of your bot

Prerequisites

  1. Have your bot listed in dsc.best

In your main file

/* The server count will not be updated till the interval time ends */

const Discord = require('discord.js')
const Client = new Discord.Client({
	intents: [Discord.Intents.FLASG.GUILDS,
	Discord.Intents.FLAGS.GUILD_MESSAGES]
})

Client.on('ready', async () => {
	await dscClient.postServerCount(1200000, true) // put it in the ready event
	/* 1200000 its the Interval of time in ms you want to post the server count, if you don't input nothing by default will be every hour in ms */
	/* True its to log in the console when the server count was posted, if you dont input anything will be false by default */
})

Client.login('YOUR-BOT-TOKEN-HERE')

Bot Information and Votes

Get information and vote's information about dsc.best listed bots

In your main file

const Discord = require('discord.js')
const Client = new Discord.Client({
	intents: [Discord.Intents.FLASG.GUILDS,
	Discord.Intents.FLAGS.GUILD_MESSAGES]
})

client.on('ready', async() => { // The methods getBotInfo and getVotes must be in a client event such as ready, messageCreate (message for v12), etc.
	/* Information */
	const botInfo = await dscClient.getBotInfo('BOT-ID-HERE') // if you have your bot listed and want to get the info you don't need to input the id 
	
	console.log(`${botInfo.name}\n${botInfo.owners}`) // Scroll down to see what information you can get
	
	/* Votes */
	const votesInfo = await dscClient.getBotVotes('BOT-ID-HERE') // if you have your bot listed and want to get the votes you don't need to input the id
	console.log(`Votes: ${votesInfo.votes}\nVoters: ${votesInfo.users}`)
})

Client.login('YOUR-BOT-TOKEN-HERE')

Information you can request about bots

  • Avatar
  • Owners
  • Badges
  • If its certified
  • If its approved
  • Servers count
  • Shards count
  • Name
  • Short Description
  • Entire Description
  • Prefix

Creators

Coder: Jelosus1 Project Setup: ASHUdev05

License

MIT License

Copyright (c) 2021 Jelosus1

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme

Keywords

Package Sidebar

Install

npm i dsc-functions

Weekly Downloads

0

Version

1.4.0

License

MIT

Unpacked Size

20 kB

Total Files

20

Last publish

Collaborators

  • jelosus1
  • ashudev05