Creating a Discord Bot#

Corkus.py was made with asynchronous applications in mind. Perfect examples of these are Discord Bots made with Discord.py. This guide gives an example how to use Corkus.py with Discord.py and similar libraries.

Let’s start from a modified example from Discord.py Quickstart. We’ have wrapped whole application intro DiscordBot class. That will simplify our life down the line.

import discord

class DiscordBot(discord.Client):
    def __init__(self):
        intents = discord.Intents.default()
        intents.message_content = True
        super().__init__(intents=intents)

    async def on_ready(self):
        print(f'We have logged in as {self.user}')

    async def on_message(self, message):
        if message.author == self.user:
            return

        if message.content.startswith('$hello'):
            await message.channel.send('Hello!')

client = DiscordBot()
client.run('your token here')

Now you need to add Corkus constructor and Corkus.start() function. This is required to make any requests using Corkus.

import discord
from corkus import Corkus

class DiscordBot(discord.Client):
    def __init__(self):
        intents = discord.Intents.default()
        intents.message_content = True
        super().__init__(intents=intents)
        self.corkus = Corkus()

    async def on_ready(self):
        print(f'We have logged in as {self.user}')

    async def setup_hook(self):
        # setup_hook is a new function added in discord.py 2.0.0. It is used to perform
        # asynchronous setup after the bot is logged in but before it has connected to
        # the websocket.
        await self.corkus.start()

    async def close(self):
        # close is called before gracefully shutting down the bot. It will make sure
        # that any internal processes of the corkus.py will be closed gracefully.
        await self.corkus.close()
        await super().close()

    async def on_message(self, message):
        if message.author == self.user:
            return

        if message.content.startswith('$hello'):
            await message.channel.send('Hello!')

    client = DiscordBot()
    client.run('your token here')

This code uses setup_hook for client initialization. Discord.py waits for this function before login to gateway. This way you can start using corkus even inside on_ready function. Now, let’s add an command to display Wynncraft players count.

import discord
from corkus import Corkus

class DiscordBot(discord.Client):
    def __init__(self):
        intents = discord.Intents.default()
        intents.message_content = True
        super().__init__(intents=intents)
        self.corkus = Corkus()

    async def on_ready(self):
        print(f'We have logged in as {self.user}')

    async def setup_hook(self):
        # setup_hook is a new function added in discord.py 2.0.0. It is used to perform
        # asynchronous setup after the bot is logged in but before it has connected to
        # the websocket.
        await self.corkus.start()

    async def close(self):
        # close is called before gracefully shutting down the bot. It will make sure
        # that any internal processes of the corkus.py will be closed gracefully.
        await self.corkus.close()
        await super().close()

    async def on_message(self, message):
        if message.author == self.user:
            return

        if message.content.startswith('$online'):
            player_sum = await self.corkus.network.players_sum()
            await message.channel.send(f'There are currently **{player_sum}** players online!')

    client = DiscordBot()
    client.run('your token here')

Congratulations! You can now use $online command to display sum of online players!

Next steps#

Next up, you can continue the guide and learn more about The Corkus Client.

Or you can check out the following resources: