NekoBox教程，创建和管理多人机器人

要使用NekoBox进行多人机器人开发,以下是详细的步骤指南：

安装NekoBox

你需要安装NekoBox框架,可以通过以下步骤进行：

1. 克隆仓库：

   git clone https://github.com/NekoBox/NekoBox.git

2. 进入仓库：

   cd NekoBox

3. 安装依赖项：

   pip install -r requirements.txt

   确保安装了所有必要的Python库,包括discord和asyncio.

4. 设置Discord API密钥：

   • 创建一个新的Discord应用程序,获取client_id和client_secret。
   • 将这些信息存储在环境变量中,

     export DISCORD_TOKEN='your_token_here'

创建一个简单的机器人

编写一个基本的机器人脚本,展示NekoBox的功能。

from nekobox.client import NekoBox
from nekobox.events import Event
from typing import Optional
class MyBot:
    def __init__(self, token: str):
        self.bot = NekoBox(token)
    async def on_ready(self):
        print("Bot is ready!")
    async def handle_message(self, event: Event, message: str):
        if message.content == '!ping':
            print("Pong!")
            await self.bot.send_message(event.channel, "Pong!")
        else:
            print(f"Message: {message.content}")
    async def run(self):
        await self.bot.start()
        await self.bot.join()
        while True:
            await self.bot.process_events()
            await asyncio.sleep(1)
if __name__ == "__main__":
    token = os.getenv("DISCORD_TOKEN")
    if not token:
        print("Please set your Discord token first.")
        exit()
    bot = MyBot(token)
    bot.run()

步骤解释：

• 导入必要模块：NekoBox和Event类，用于创建机器人实例和处理事件。
• 定义机器人类MyBot：继承自NekoBox，初始化机器人并注册事件处理函数。
• on_ready方法：当机器人就绪时打印消息。
• handle_message方法：处理消息，响应!ping命令并发送“Pong!”消息。
• run方法：启动机器人，连接到Discord，并进入事件处理循环。

运行机器人

将这个脚本保存为bot.py，然后运行：

python bot.py

注意事项：

• 确保环境变量DISCORD_TOKEN已正确设置。
• 如果没有设置Token,程序会提示你设置。

创建多机器人实例

为了创建多个机器人,需要为每个实例单独初始化并管理。

from nekobox.client import NekoBox
from typing import Optional
import os
import asyncio
from pathlib import Path
class MultiBot:
    def __init__(self, token: str, bot_name: str):
        self.bot = NekoBox(token)
        self.bot_name = bot_name
        self.process_count = 0
    async def on_ready(self):
        print(f"{self.bot_name} is ready!")
    async def handle_message(self, event: Event, message: str):
        if message.content == '!ping':
            print(f"{self.bot_name} pong!")
            await self.bot.send_message(event.channel, f"{self.bot_name} Pong!")
        else:
            print(f"{self.bot_name} received: {message.content}")
    async def run(self):
        await self.bot.start()
        await self.bot.join()
        while True:
            self.process_count +=1
            await asyncio.sleep(1)
            if self.process_count >= 5:
                print(f"{self.bot_name} is shutting down...")
                await self.bot.process_events()
                await self.bot.close()
                break
if __name__ == "__main__":
    token = os.getenv("DISCORD_TOKEN")
    if not token:
        print("Please set your Discord token first.")
        exit()
    bots = []
    for i in range(5):
        bot_name = f"Bot{i}"
        bot = MultiBot(token, bot_name)
        bot.run()

步骤解释：

• MultiBot类：继承自NekoBox，支持多个机器人实例。
• __init__方法：初始化机器人并设置名称和计数器。
• on_ready方法：打印机器人就绪消息。
• handle_message方法：处理消息，响应!ping命令。
• run方法：启动机器人，并在一段时间后关闭机器人。

插件系统的使用

NekoBox支持插件系统,可以通过创建自定义插件来扩展机器人的功能。

创建一个简单的插件

from nekobox.plugins import BasePlugin
from typing import Optional
class MyPlugin(BasePlugin):
    def __init__(self, bot):
        super().__init__(bot)
        self.name = "myplugin"
        self.description = "A simple plugin"
    async def command(self, cmd: str, args: Optional[list[str]] = None):
        if cmd == "ping":
            await self.send_message("pong!")

使用插件

在你的机器人类中加载插件：

from nekobox.client import NekoBox
from nekobox.events import Event
from myplugin import MyPlugin
class MyBot:
    def __init__(self, token: str):
        self.bot = NekoBox(token)
        self.plugins = []
    async def on_ready(self):
        print("Bot is ready!")
        # 加载插件
        self.plugins.append(MyPlugin(self.bot))
    async def handle_message(self, event: Event, message: str):
        if message.content == '!ping':
            for plugin in self.plugins:
                if plugin.command("ping"):
                    print("Pong!")
    async def run(self):
        await self.bot.start()
        await self.bot.join()
        while True:
            await self.bot.process_events()
            await asyncio.sleep(1)

步骤解释：

• 创建插件类MyPlugin：继承自BasePlugin，实现自定义命令处理。
• 加载插件：在机器人初始化时，创建插件实例并添加到列表中。
• 处理命令：在handle_message中调用插件处理命令。

错误处理和日志记录

确保你的机器人能够处理错误并记录日志。

import logging
from nekobox.client import NekoBox
from typing import Optional
class MyBot:
    def __init__(self, token: str):
        self.bot = NekoBox(token)
        logging.basicConfig(level=logging.INFO)
    async def on_ready(self):
        print("Bot is ready!")
    async def handle_error(self, error: Exception, event: Event):
        logging.error(f"Error occurred in {event.command} command.", exc_info=True)
        await self.bot.send_message(event.channel, "An error occurred!")
    async def run(self):
        try:
            await self.bot.start()
            await self.bot.join()
            while True:
                await self.bot.process_events()
                await asyncio.sleep(1)
        except Exception as e:
            logging.error(f"Bot stopped: {str(e)}")
            await self.bot.close()

步骤解释：

• 设置日志：使用logging.basicConfig配置日志水平。
• 错误处理：在异常处理函数中记录错误信息并发送消息。

部署和监控

部署你的机器人到生产环境,确保它能稳定运行。

• 使用PM2监控：

  pm2 start bot.py
  pm2 save
  pm2 startup

• 配置启动脚本：

  @echo 'Starting NekoBox bot...'
  @python bot.py

注意事项：

• 确保服务器支持PM2或类似的工具来监控和管理机器人的运行。
• 定期检查日志,处理崩溃和重启。

进一步的开发

• 高级插件开发：创建复杂插件，集成第三方库。
• 命令系统：使用命令系统创建更复杂的功能。
• 事件处理：处理更多类型的事件，如成员加入、消息类型等。

通过实践和不断探索,你可以逐步掌