PigPig: Advanced Multi-modal LLM Discord Bot

English | 繁體中文

Introduction

PigPig is a powerful, multi-modal Discord bot powered by Large Language Models (LLMs). It's designed to interact with users through natural language, combining advanced AI capabilities with practical, fun features to enrich any Discord community.

Invite PigPig to your server!

📄 Legal Documents

To ensure user rights and service transparency, please refer to the following documents:

• Terms of Service: TERMS_OF_SERVICE.md
• Privacy Policy: PRIVACY_POLICY.md
• Support Email: [email protected]
• Support Server: https://discord.gg/BvP64mqKzR

🌟 Key Features

• 🧠 AI-Powered Conversations: Utilizes advanced LLMs for natural language understanding and generation.
• 🖼️ Multi-modal Capabilities: Supports visual question answering (VQA) and AI image generation.
• 🎵 Music Playback: Plays music from YouTube, SoundCloud and Spotify links with seeking, audio effects (nightcore, 8D, karaoke ...), synced lyrics, personal and server playlists, a DJ role with vote skipping, 24/7 mode and a song request channel.
• 🧠 Intelligent Channel Memory: Permanently stores and intelligently retrieves conversation history with semantic search to provide enhanced context for responses.
• 🔄 Auto-Update System: Automatically checks for and applies GitHub updates with secure backups and rollback functionality.
• 🍽️ Practical Tools: Set reminders, get restaurant recommendations, perform calculations, and more.

📸 Feature Showcase

🚀 Getting Started

System Requirements

• Essential Dependencies:

  • Python 3.11+
  • FFmpeg (For music playback)

  FFmpeg Installation:

  • Ubuntu/Debian: sudo apt update && sudo apt install ffmpeg

  • CentOS/RHEL: sudo yum install epel-release && sudo yum install ffmpeg

  • macOS: brew install ffmpeg

  • Windows: Download from FFmpeg Windows builds

  • Python packages listed in requirements.txt

Installation Steps

# Clone the repository
git clone https://github.com/starpig1129/discord-LLM-bot-PigPig.git

# Navigate to the project directory
cd discord-LLM-bot-PigPig

# Install required Python packages
pip install -r requirements.txt

⚙️ Configuration

Follow these steps to configure your bot instance.

Step 1: Configure .env file

Rename the .env Example file to .env and fill in the required values.

# .env

# --- Discord Bot Credentials ---
TOKEN=XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXX
CLIENT_ID=123456789012345678
CLIENT_SECRET_ID=XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXX

# --- Dashboard Secret ---
# Generate with: python3 -c "import secrets; print(secrets.token_urlsafe(64))"
DASHBOARD_SECRET_KEY=<generate-a-random-64-char-secret>

# --- Bot Configuration ---
BOT_OWNER_ID=123456789012345678
BUG_REPORT_CHANNEL_ID=123456789012345678

# --- AI Model Configuration ---
MODEL_NAME=openbmb/MiniCPM-o-2_6
ANTHROPIC_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
GEMINI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

# --- Vector Database API Keys ---
VECTOR_STORE_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

# --- Bot Configuration File Path ---
CONFIG_ROOT="/path/to/your/config"

This is the beginning of the README. Read the rest at the original. Read the full README ↗