@devtomio/plugin-botlist

@devtomio/plugin-botlist

Plugin for @sapphire/framework to post stats to several discord bot lists.

Description

This plugin enables the integration of many bot lists such as Top.gg, Discord Labs, and others.

Features

• Fully ready for TypeScript!
• Includes ESM ready entrypoint
• Easy to use
• Auto-detection of enabled sites

Installation

@devtomio/plugin-botlist depends on the following packages. Be sure to install these along with this package!

• @sapphire/framework

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @devtomio/plugin-botlist @sapphire/framework discord.js

---

Usage

JavaScript

In your main or setup file, register the plugin:

require('@devtomio/plugin-botlist/register');

require('@devtomio/plugin-botlist/register');

const client = new SapphireClient({
	/* your bot options */
	botList: {
		clientId: 'YOUR_CLIENT_ID', // Optional; by default it is the bot's id
		debug: false, // (Optional), shows debug messages; by default it is false
		shard: false, // (Optional), enable sharding support; by default it is false
		autoPost: {
			enabled: true, // (Optional); by default it is enabled
			interval: 3_600_000 // (Optional); by default it is set to 1 hour
		},
		keys: {
			topGG: 'YOUR_AWESOME_TOP_GG_API_KEY' // Your top.gg API key (a list will be found below)
		}
	}
});

async function main() {
	await client.login();
}

void main();

TypeScript

In your main or setup file, register the plugin:

import '@devtomio/plugin-botlist/register';

import '@devtomio/plugin-botlist/register';

const client = new SapphireClient({
	/* your bot options */
	botList: {
		clientId: 'YOUR_CLIENT_ID', // Optional; by default it is the bot's id
		debug: false, // (Optional), shows debug messages; by default it is false
		shard: false, // (Optional), enable sharding support; by default it is false
		autoPost: {
			enabled: true, // (Optional); by default it is enabled
			interval: 3_600_000 // (Optional); by default it is set to 1 hour
		},
		keys: {
			topGG: 'YOUR_AWESOME_TOP_GG_API_KEY' // Your top.gg API key (a list will be found below)
		}
	}
});

async function main() {
	await client.login();
}

void main();

If you enable the autoPost option, the plugin will automatically publish the data for you; you don't need to do anything else!

List of Supported Sites

• Top.gg | topGG
• Discord Bot List | discordBotList
• Bots on Discord | botsOnDiscord
• Discords | discords
• Discord Labs | discordLabs
• BotList.me | botListMe
• Discord Bots | discordBotsGG
• Discord Extreme List | discordExtremeList
• Blist | blist
• Discord Services | discordServices
• Disforge | disforge
• Infinity Bot List | infinityBots
• Void Bots | voidBots

Contributors

Thank you to all the people who already contributed to this project!

Changelog

1.3.0 - (2023-01-28)

🐛 Bug Fixes

• deps: Update dependency tslib to ^2.5.0 (8d772ac)
• post: Parse error http request (#60) (36953c7)
• deps: Update dependency @sapphire/fetch to ^2.4.1 (1d1e76f)
• deps: Update dependency @sapphire/fetch to ^2.4.0 (7c1f9f6)
• #7 (87aff0f)
• lint: Error (c22914c)
• lint: Remove tests dir (3877e04)

📝 Documentation

• Changelog (23882b3)
• Add @devtomio as a contributor (856fc17)

🚀 Features

• Switch to undici (#64) (ca45be8)
• Add discordlist.gg provider (#59) (6fa87f4)
• Support shards (#10) (074e51c)
• *: First release (13127cb)

🪞 Styling

• Run prettier (184d6c4)