starlitghost/desertbot

DesertBot 镜像文档

镜像概述

DesertBot 是一个模块化的IRC机器人，使用Python编写，具备强大的别名功能。该项目部分受 https://github.com/ElementalAlchemist/txircd 启发，并使用其BSD许可下的部分代码。其核心设计目标是提供灵活的扩展能力，允许用户通过模块动态扩展功能。

核心功能和特性

• 动态别名系统：可将多种操作别名化为新命令，并支持别名嵌套，实现复杂功能组合
• 数据提取工具：
  • Slurp：从HTML/XML中提取数据
  • Jostle：从JSON中提取数据
• 模块链功能：
  • 通过 Sub 或 Chain 链接多个模块
  • 使用 Var 存储数据，支持同一命令内多次使用（如重复提取同一URL内容）
• URL跟踪：自动跟踪聊天中发布的URL重定向，返回页面标题和最终主机名，对Imgur、KickStarter、Steam、***、和链接提供专项信息提取
• 消息修正工具：
  • 识别sed-like模式，替换最近20条消息中的匹配内容
  • 支持*correction样式修正，替换用户上一条消息中最可能的目标单词
• 长消息处理：AutoPaste 模块可检测超过2条IRC消息长度的响应，自动提交至paste***服务并返回链接
• 统一帮助系统：通过 Help 模块为所有功能提供一致的帮助信息
• 模块化管理：所有功能可通过加载/卸载对应模块单独启用或禁用（模块列表见 modules 目录）

使用场景和适用范围

• IRC社区日常管理与自动化
• 自定义聊天命令创建与扩展
• 链接自动解析与信息提取
• 聊天消息修正与格式处理
• 长文本内容自动转换（paste***集成）
• 需要高度定制化的IRC机器人场景

使用方法和配置说明

环境要求

• Docker环境
• Docker Compose工具

配置步骤

1. 克隆代码仓库

   bash
   git clone https://github.com/DesertBot/DesertBot.git
   cd DesertBot
   

2. 配置基础参数

   • 编辑 configs/_defaults.yaml 设置机器人所有者及其他基础信息
   • 复制服务器配置示例创建网络专用配置：

     bash
     cp configs/server.yaml.example configs/server.yaml
     

   • 编辑 configs/server.yaml 配置IRC网络连接参数（每个IRC网络需单独配置）

3. 配置Docker Compose

   • 复制Docker Compose示例文件：

     bash
     cp docker-compose-example.yml docker-compose.yml
     

   • 编辑 docker-compose.yml，指定上一步创建的服务器配置文件路径

Docker部署命令

启动机器人容器：

bash
docker-compose up -d desertbot-server

验证部署

查看容器运行状态：

bash
docker-compose ps

查看日志输出：

bash
docker-compose logs -f desertbot-server

注意事项

• 所有功能模块可通过加载/卸载独立管理，无需重启机器人
• 支持多IRC网络部署，每个网络需单独配置服务器配置文件
• 配置文件修改后需重启容器使变更生效