Common Usage Cases

Core Setup Guide#

We are going to learn how to start using library and combine it with currently used code.

We are going to use discord.js package.

Setup#

Here is the very simple discord bot setup we're going to use.

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'

const client = new Client()

client.on('ready', () => console.log("I'm ready sir o7"))

client.login('DISCORD_TOKEN')

Creating Client#

Now that we have a basic setup we can create our GatewayClient to start interacting with dclist

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'
import { GatewayClient } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN'
})

client.on('ready', () => console.log("I'm ready sir o7"))

client.login('DISCORD_TOKEN')

Voter-Only Commands#

You may have some voter-only features. You can do that easily using official sdk.

There is as veeery simple example for using #isUserVoted method of GatewayClient.

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'
import { GatewayClient } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN'
})

client.on('ready', () => console.log("I'm ready sir o7"))

client.on('message', async (message) => {
    if (message.author.bot) return
    if (message.content.startsWith('!voterOnly')) {
        const userVoted = await dclClient.isUserVoted(message.author.id)
        if (!userVoted) {
            message.reply(`you need to vote if you want to use this command. You can vote from here : https://dclist.net/bots/${client.user.id}/vote`)
            return
        }
    }
    // Do Some Fancy Stuff Here
})

client.login('DISCORD_TOKEN')

Subscribe to Events#

Dclist using a bit different system to handle real time events. Instead of creating an express just for new vote event, directly connecting to server using websockets.

That means you don't have to set up any other settings to use events.

Here is a veeery simple vote logger code just to give an idea.

Demanding Events#

First you need to tell server about which events you want to receive. Then server will start sending events in real time to you.

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'
import { GatewayClient, SubscriptionsTopicsEnum } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN'
})

// That's a sync method. Don't need to use async/await
dclClient.subscribeTo([SubscriptionsTopicsEnum.NEW_VOTE])

client.on('ready', () => console.log("I'm ready sir o7"))

client.on('message', async (message) => {
    if (message.author.bot) return
    if (message.content.startsWith('!voterOnly')) {
        const userVoted = await dclClient.isUserVoted(message.author.id)
        if (!userVoted) {
            message.reply(`you need to vote if you want to use this command. You can vote from here : https://dclist.net/bots/${client.user.id}/vote`)
            return
        }
    }
    // Do Some Fancy Stuff Here
})

client.login('DISCORD_TOKEN')

Handling Events#

When a real time event received, GatewayClient will emit an event named same as received event's type.

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'
import { GatewayClient, SubscriptionsTopicsEnum } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN'
})

// That's a sync method. Don't need to use async/await
dclClient.subscribeTo([SubscriptionsTopicsEnum.NEW_VOTE])

dclCLient.on(SubscriptionsTopicsEnum.NEW_VOTE, (vote) => {
    const logChannel = client.channels.cache.get('LOG_CHANNEL_ID') as TextChannel
    logChannel.send(`Thank you <@${vote.payload.user.id}> for your vote`)
})

client.on('ready', () => console.log("I'm ready sir o7"))

client.on('message', async (message) => {
    if (message.author.bot) return
    if (message.content.startsWith('!voterOnly')) {
        const userVoted = await dclClient.isUserVoted(message.author.id)
        if (!userVoted) {
            message.reply(`you need to vote if you want to use this command. You can vote from here : https://dclist.net/bots/${client.user.id}/vote`)
            return
        }
    }
    // Do Some Fancy Stuff Here
})

client.login('DISCORD_TOKEN')

AutoPoster Usage#

You need to send some report to the site so we can display your bot's guild, user, etc. count and track your growth rate for you.

You can achive that with few lines of change. There is an example for sharded and standalone bots.

Stand-Alone Bot Setup#

TypeScript
JavaScript

app.ts

import { Client } from 'discord.js'
import { GatewayClient } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN',
    // !IMPORTANT!
    client: client,
    enablePoster: true,
    // !IMPORTANT!
})

client.on('ready', () => console.log("I'm ready sir o7"))

client.login('DISCORD_TOKEN')

Multi-Sharded Bot Setup#

Shard Manager File#

TypeScript
JavaScript

sharder.ts

import { ShardingManager } from 'discord.js'
import { GatewayClient } from '@dclist/sdk'

const shardManager = new ShardingManager(...)

const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN',
    // !IMPORTANT!
    client: shardManager,
    enablePoster: true,
    // !IMPORTANT!
})

client.on('ready', () => console.log("I'm ready sir o7"))

shardManager.spawn()

Shard Client File#

TypeScript
JavaScript

shard.ts

import { Client } from 'discord.js'
import { GatewayClient } from '@dclist/sdk'

const client = new Client()
const dclClient = new GatewayClient({
    token: 'DCLIST_TOKEN',
    // Don't pass client or enablePoster properties
})

client.on('ready', () => console.log("I'm ready sir o7"))

client.login('DISCORD_TOKEN')