Vote Tracker is an npm package designed to track votes on Discord bots from top.gg and log them to a specified Discord channel.
- Support TypeScript
- 100% Customizable
- Easy to setup
You can install the package via npm:
npm install vote-tracker
To use the package, follow these steps:
Common Js
const { Client, GatewayIntentBits } = require('discord.js');
const VoteTracker = require('vote-tracker');
// Create a Discord.js client
const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildMembers,
GatewayIntentBits.GuildMessages,
GatewayIntentBits.MessageContent
]
})
// Initialize VoteTracker with client instance and options
const voteTracker = new VoteTracker(client, {
guildId: 'YOUR_GUILD_ID',
roleId: 'YOUR_ROLE_ID', // Optional: specify role id
channelId: 'YOUR_VOTE_LOG_CHANNEL_ID',
webhook: 'YOUR_WEBHOOK_URL',
postmode: 'channel', // Which post mode do you want? This means how you want to post your logs, using embed or webhook. Its default value is channel.
password: 'YOUR_TOPGG_AUTH_TOKEN',
color: '#333333', // Optional, specify embed color
port: '3000', // Optional, specify port number
reminder: true, // Do you want to enable reminders? This means if you want to remind a user to vote again after 12 hours, set it to true. Otherwise, set it to false. Its default value is true.
});
client.on('ready', () => {
console.log(`${client.user.username} is now online`);
voteTracker.init()
});
client.login('YOUR_DISCORD_BOT_TOKEN');Typescript
import { Client, GatewayIntentBits } from 'discord.js';
import { VoteTracker, VoteTrackerOptions } from 'vote-tracker';
// Create a Discord.js client instance
const client = new Client({
intents: [
GatewayIntentBits.Guilds,
GatewayIntentBits.GuildMembers,
GatewayIntentBits.GuildMessages,
GatewayIntentBits.MessageContent
]
});
// Define options for the VoteTracker
const options: VoteTrackerOptions = {
guildId: 'YOUR_GUILD_ID',
roleId: 'YOUR_ROLE_ID', // Optional: specify role id
channelId: 'YOUR_VOTE_LOG_CHANNEL_ID',
webhook: 'YOUR_WEBHOOK_URL',
postmode: 'channel', // Which post mode do you want? This means how you want to post your logs, using embed or webhook. Its default value is channel.
password: 'YOUR_TOPGG_AUTH_TOKEN',
color: '#333333', // Optional, specify embed color
port: '3000', // Optional, specify port number
reminder: true, // Do you want to enable reminders? This means if you want to remind a user to vote again after 12 hours, set it to true. Otherwise, set it to false. Its default value is true.
};
// Create an instance of VoteTracker
const voteTracker = new VoteTracker(client, options);
client.on('ready', () => {
console.log(`${client.user?.username} is now online`);
voteTracker.init();
});
client.login('YOUR_DISCORD_BOT_TOKEN');With this example, your webhook dashboard should look like this:
-
new VoteTracker(client[, options]): Creates a new instance of VoteTracker.client: Required. The Discord.js client instance.options: Optional. An object containing additional configuration options.guildId: The ID of your guild.roleId: Optional. The ID of the role to assign to users upon voting.channelId: The ID of the channel where vote logs will be sent.webhook: The webhook url where vote logs will be sent.postmode: Which post mode do you want? This means how you want to post your logs, using embed or webhook.password: Your top.gg authentication token.color: Optional. The color of the embeds. Defaults to '#333333'.port: Optional. The port number. Defaults to '3000'.reminder: Do you want to enable reminders? This means if you want to remind a user to vote again after 12 hours, set it to true. Otherwise, set it to false. Its default value is true.
Common Js
const VoteTracker = require('vote-tracker');
// Initialize VoteTracker with client instance and options
const voteTracker = new VoteTracker(client, {
guildId: 'YOUR_GUILD_ID',
roleId: 'YOUR_ROLE_ID', // Optional: specify role id
channelId: 'YOUR_VOTE_LOG_CHANNEL_ID',
webhook: 'YOUR_WEBHOOK_URL',
postmode: 'channel', // Which post mode do you want? This means how you want to post your logs, using embed or webhook. Its default value is channel.
password: 'YOUR_TOPGG_AUTH_TOKEN',
color: '#333333', // Optional, specify embed color
port: '3000', // Optional, specify port number
reminder: true, // Do you want to enable reminders? This means if you want to remind a user to vote again after 12 hours, set it to true. Otherwise, set it to false. Its default value is true.
});
// start the VoteTracker instance
voteTracker.init()Typescript
import { VoteTracker, VoteTrackerOptions } from 'vote-tracker';
const options: VoteTrackerOptions = {
guildId: 'YOUR_GUILD_ID',
roleId: 'YOUR_ROLE_ID', // Optional: specify role id
channelId: 'YOUR_VOTE_LOG_CHANNEL_ID',
webhook: 'YOUR_WEBHOOK_URL',
postmode: 'channel', // Which post mode do you want? This means how you want to post your logs, using embed or webhook. Its default value is channel.
password: 'YOUR_TOPGG_AUTH_TOKEN',
color: '#333333', // Optional, specify embed color
port: '3000', // Optional, specify port number
reminder: true, // Do you want to enable reminders? This means if you want to remind a user to vote again after 12 hours, set it to true. Otherwise, set it to false. Its default value is true.
};
// Create an instance of VoteTracker
const voteTracker = new VoteTracker(client, options);
// start the VoteTracker instance
voteTracker.init()This project is licensed under the MIT License - see the LICENSE file for details.