jheddings/idlebot

IdleRPG IRC Bot 镜像

镜像概述和主要用途

IdleRPG IRC Bot 镜像是一个轻量级的IRC（互联网中继聊天）机器人应用，专门设计用于在IRC网络上与IdleRPG游戏系统交互。该镜像提供了连接IRC服务器、响应IdleRPG游戏指令的核心功能，帮助用户自动化或简化IdleRPG游戏中的常见操作（如战斗、探索、任务管理等），适用于希望提升游戏体验的IdleRPG玩家。

核心功能和特性

• IRC网络适配：支持连接至任意IRC服务器，兼容标准IRC协议，可配置服务器地址、端口、身份验证等参数。
• IdleRPG指令响应：内置对IdleRPG游戏核心指令的解析与执行逻辑，可自动响应游戏系统消息并执行对应操作。
• 配置灵活性：通过环境变量或配置文件自定义机器人昵称、加入频道、游戏策略（如自动战斗、资源管理规则）等参数。
• 轻量级设计：镜像体积小巧，运行时资源占用低，可在个人服务器、云主机等多种环境中高效部署。
• 稳定性保障：具备网络中断自动重连机制，确保机器人持续在线并与游戏系统保持交互。

使用场景和适用范围

• IdleRPG游戏玩家：需自动化重复游戏操作（如日常任务、战斗指令发送）以节省时间的用户。
• IRC频道管理员：希望在IRC频道中集成IdleRPG游戏功能，为频道用户提供便捷游戏入口的管理者。
• IRC生态开发者：可基于此镜像扩展功能，如添加自定义游戏策略、集成第三方通知系统等。

适用环境包括各类公共或私有IRC网络（如Freenode、EFNet等），以及支持Docker的Linux、Windows、macOS系统。

使用方法和配置说明

基本部署（docker run）

通过以下命令快速启动机器人，连接至指定IRC服务器并加入目标频道：

bash
docker run -d \
  --name idlerpg-irc-bot \
  -e IRC_SERVER=irc.example.com \
  -e IRC_PORT=6667 \
  -e BOT_NICK=idlebot \
  -e IRC_CHANNEL=#idlerpg \
  -e IDLERPG_PREFIX=!idle \
  docker.xuanyuan.run/your-image-name:latest

核心环境变量配置

Docker Compose 配置示例

创建docker-compose.yml文件，实现更灵活的部署与持久化配置：

yaml
version: '3'
services:
  idlerpg-bot:
    image: docker.xuanyuan.run/your-image-name:latest
    container_name: idlerpg-irc-bot
    restart: unless-stopped
    environment:
      - IRC_SERVER=irc.example.com
      - IRC_PORT=6697
      - IRC_USE_SSL=true
      - BOT_NICK=my-idle-bot
      - IRC_CHANNEL=#idle-games,#rpg-chat
      - IDLERPG_PREFIX=!rpg
      - LOG_LEVEL=debug
    volumes:
      - ./bot-config:/app/config  # 挂载配置文件目录（如需自定义策略规则）

注意事项

• 部分IRC服务器要求昵称注册或身份验证，需提前在目标服务器注册机器人昵称并配置认证信息（如SASL_PASSWORD，具体参数以镜像支持为准）。
• 根据IdleRPG游戏系统的指令规则调整IDLERPG_PREFIX及相关配置，确保机器人能正确解析游戏消息（可参考目标IRC频道的IdleRPG使用说明）。
• 如需持久化日志或配置，可通过volumes挂载本地目录至容器内对应路径（如日志目录/app/logs）。