https://github.com/jpbberry/topgg-autoposter

Top.gg Auto-Posting made easy.
https://github.com/jpbberry/topgg-autoposter

autoposter discord top-gg

Last synced: 4 months ago
JSON representation

Top.gg Auto-Posting made easy.

• Host: GitHub
• URL: https://github.com/jpbberry/topgg-autoposter
• Owner: jpbberry
• Created: 2020-12-02T22:40:02.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-17T19:23:28.000Z (12 months ago)
• Last Synced: 2024-09-19T23:43:12.539Z (5 months ago)
• Topics: autoposter, discord, top-gg
• Language: TypeScript
• Homepage: https://npmjs.com/package/topgg-autoposter
• Size: 27.3 KB
• Stars: 12
• Watchers: 2
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Top.gg AutoPoster

Easy AutoPosting via the [top.gg sdk](https://npmjs.com/package/@top-gg/sdk)

# How to

It's really really simple! All you gotta do is:

```js

const { AutoPoster } = require('topgg-autoposter')

const poster = AutoPoster('topggtoken', client) // your discord.js or eris client

// optional

poster.on('posted', (stats) => { // ran when succesfully posted

  console.log(`Posted stats to Top.gg | ${stats.serverCount} servers`)

})

```

*You can also do poster.on('error', (err) => { ... }) and this will stop errors from being logged and left for you to handle*

And that's it!

It will begin to post your server count, and shard count every 30 minutes.

This even work on individual Discord.JS shards that are process separated.

If you would like to do specific clients, `DJSPoster` & `ErisPoster` & `DJSSharderPoster` & `RosePoster` are all exported classes!

## Traditional Discord.JS Sharding:

If you use Discord.JS' traditional `ShardingManager` sharder, you can also append the AutoPoster to the sharding manager like so:

```js

const sharder = new Discord.ShardingManager(...)

const poster = AutoPoster('topggtoken', sharder)

sharder.spawn() // rest of your stuff!

```

This will run broadcastEval's and automatically fetch your statistics!

## [Discord-Rose](https://npmjs.com/discord-rose) posting

```js

const master = new Master(...)

const poster = AutoPoster('topggtoken', master)

```

And it will run everything through comms.getStats() function