botpy

To build a bot with botpy, you follow a three-step pattern:

1. Inherit from bot.Client: Create a custom class that inherits from botpy.Client to define your bot's logic.
2. Implement Event Handlers: Define asynchronous methods within your class to handle specific events (e.g., on_at_message_create). Each event handler receives a specific data object (e.g., botpy.message.Message for message events).
3. Configure Intents and Run: Initialize botpy.Intents to specify which event channels your bot should listen to, then instantiate your client and call .run() with your appid and secret.

Note: Authentication in newer versions (v1.1.5+) requires both appid and secret (AppSecret).

import botpy
from botpy.message import Message

# 1. Inherit from botpy.Client
class MyClient(botpy.Client):
    # 2. Implement event handlers
    async def on_at_message_create(self, message: Message):
        await message.reply(content=f"Bot {self.robot.name} received your @message: {message.content}")

# 3. Set intents and run
intents = botpy.Intents(public_guild_messages=True) 
client = MyClient(intents=intents)
client.run(appid="12345", secret="xxxx")

To build a bot, follow these three steps:

1. Inherit from botpy.Client: Create your own client class.
2. Implement event handlers: Override methods like on_ready or on_at_message_create to handle specific bot events. Note that event handlers receive specific data objects (e.g., Message for message events).
3. Configure Intents and Run: Define which events the bot should listen to using botpy.Intents, instantiate your client, and call .run() with your appid and token.

import botpy
from botpy.types.message import Message

class MyClient(botpy.Client):
    async def on_ready(self):
        print(f"robot 「{self.robot.name}」 on_ready!")

    async def on_at_message_create(self, message: Message):
        # Automatically reply when @mentioned
        await message.reply(content=f"机器人{self.robot.name}收到你的@消息了: {message.content}")

# Set up intents to listen for public guild messages
intents = botpy.Intents(public_guild_messages=True)
client = MyClient(intents=intents)

# Start the client
client.run(appid="12345", token="xxxx")

To receive specific events, you must configure botpy.Intents when initializing your client. There are two primary ways to define intents: passing them directly to the constructor or modifying an existing Intents object.

Method 1: Direct Initialization

Pass the desired intent flags directly into the botpy.Intents() constructor.

Method 2: Incremental Configuration

Initialize with botpy.Intents.none() and then set specific attributes to True.

Shortcut Methods

• botpy.Intents.all(): Subscribes to all available events.
• botpy.Intents.default(): Subscribes to all default public events.

# Method 1: Direct
intents = botpy.Intents(public_guild_messages=True, direct_message=True, guilds=True)
client = MyClient(intents=intents)

# Method 2: Incremental
intents = botpy.Intents.none()
intents.public_guild_messages = True
intents.direct_message = True
intents.guilds = True

# Shortcuts
intents = botpy.Intents.all()
intents = botpy.Intents.default()

To monitor forum activity (threads, posts, replies, and audit results), subscribe to the forums intent.

Note: This intent is only available for Private (私域) bots.

Required imports:

• botpy.Intents
• botpy.forum.Thread
• botpy.types.forum.Post, Reply, AuditResult

import botpy
from botpy.forum import Thread
from botpy.types.forum import Post, Reply, AuditResult

# Note: Only Private bots can set this intent
intents = botpy.Intents(forums=True)

class MyClient(botpy.Client):
    async def on_forum_thread_create(self, thread: Thread):
        pass
    async def on_forum_thread_update(self, thread: Thread):
        pass
    async def on_forum_thread_delete(self, thread: Thread):
        pass
    async def on_forum_post_create(self, post: Post):
        pass
    async def on_forum_post_delete(self, post: Post):
        pass
    async def on_forum_reply_create(self, reply: Reply):
        pass
    async def on_forum_reply_delete(self, reply: Reply):
        pass
    async def on_forum_publish_audit_result(self, auditresult: AuditResult):
        pass