diff --git a/README.md b/README.md index 3412049..6bb1dc4 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,82 @@ -# 🖼️ Discord 猜圖片機器人 +# Discord 猜謎互動機器人 (Lottery Bot) -一個用 Python 和 discord.py 開發的 Discord 猜圖片互動機器人! +這是一個基於 `discord.py` 開發的互動式 Discord 機器人,專門用於舉辦「看圖猜寶可夢」或「經典動畫角色」的猜謎活動。支援斜線指令 (Slash Commands) 並具備自動倒數計時與總複習功能。 -## ✨ 功能特色 +## 🌟 功能亮點 -- 🖼️ 發送圖片讓人猜是什麼 -- 🎯 投票互動系統 -- 🎉 恭喜猜對者 -- 🎲 隨機答案提示 -- 📖 基礎功能指令:`!info`, `!help`, `!ping`, `!echo` -- ⚡ 支援 Slash Commands (`/info`, `/help`, `/ping`, `/echo`) +* **看圖猜謎**:內建寶可夢(150+隻)與經典動畫角色資料庫。 +* **倒數計時**:出題後自動進入倒數,時間到自動公佈答案與圖片。 +* **清單管理**:自動洗牌題目,並記錄目前進度,避免重複出現相同題目。 +* **總複習模式**:自動播放模式,每秒巡迴顯示一位角色。 +* **基礎工具**:提供延遲測試 (Ping) 與機器人資訊查詢。 -## 🚀 安裝與設定 +## 🛠️ 專案結構 + +* `discord-bot.py`: 機器人啟動入口,處理 Cog 載入與指令同步。 +* `cogs/` +* `base.py`: 存放基礎指令(如 info, ping)。 +* `lottery.py`: 核心功能,處理猜謎邏輯、清單管理與倒數計時。 + + +* `pokemon.json`: 寶可夢圖片與名稱資料庫。 +* `animate.json`: 動畫角色圖片與作品資料庫。 +* `.env`: 存放敏感資訊(如 Token、Guild ID)。 + +## ⚙️ 安裝教學 + +### 1. 準備環境 + +確保您的環境已安裝 Python 3.8 或以上版本。 + +### 2. 安裝必要套件 + +在終端機執行以下指令: -### 1. 克隆專案 ```bash -cd /home/tangsong/.openclaw/workspace/projects/discord-guess-img-bot +pip install discord.py python-dotenv + ``` -### 2. 安裝依賴 -```bash -pip install -r requirements.txt -``` +### 3. 設定環境變數 + +建立一個 `.env` 檔案(或參考 `.env.example`),並填入您的資訊: -### 3. 設定 Discord Bot Token -1. 前往 [Discord Developer Portal](https://discord.com/developers/applications) -2. 創建一個新應用程式 -3. 在 Bot 分頁創建機器人 -4. 複製你的 **Token** -5. 建立 `.env` 檔案: -```bash -cp .env.example .env -``` -6. 編輯 `.env` 檔案,填入你的 token: ```env -DISCORD_BOT_TOKEN=your_actual_token_here +DISCORD_BOT_TOKEN=你的機器人Token +GUILD_ID=你的伺服器ID + ``` -### 4. 執行機器人 +### 4. 啟動機器人 + ```bash python discord-bot.py + ``` -## 📖 指令說明 +## 🎮 指令說明 + +### 猜謎指令 (`/`) + +| 指令 | 說明 | +| --- | --- | +| `/建立抽選清單` | 重新打亂並初始化寶可夢或動畫角色的題目清單。 | +| `/抽選清單` | 顯示目前剩餘的題目數量。 | +| `/抽寶可夢 [秒數]` | 隨機出一題寶可夢,並在指定秒數後揭曉答案。 | +| `/抽動畫 [秒數]` | 隨機出一題動畫角色,並在指定秒數後揭曉答案。 | +| `/動畫角色總複習` | 開始自動播放所有動畫角色圖片。 | +| `/停止` | 停止進行中的總複習模式。 | ### 基礎指令 -- `!info` - 顯示機器人資訊 -- `!help` - 顯示幫助訊息 -- `!ping` - 測試機器人連線 -- `!echo <訊息>` - 回覆你的訊息 -### Slash Commands -- `/info` - 顯示機器人資訊 -- `/help` - 顯示幫助訊息 -- `/ping` - 測試機器人連線 -- `/echo <訊息>` - 回覆你的訊息 - -## 🔧 專案結構 - -``` -discord-guess-img-bot/ -├── discord-bot.py # 主程式 -├── cogs/ -│ └── base.py # 基礎功能 Cog -├── .env.example # 環境變數範例 -├── requirements.txt # Python 依賴 -└── README.md # 專案說明 -``` - -## 🚧 待開發功能 - -- [ ] 猜圖片互動功能 -- [ ] 投票系統 -- [ ] 答案統計 -- [ ] 資料庫支援 -- [ ] 自訂機器人回應 - -## 🤝 貢獻 - -歡迎提交 Issue 和 Pull Request! - -## 📄 授權 - -MIT License +| 指令 | 說明 | +| --- | --- | +| `/info` | 查看機器人當前狀態與伺服器統計。 | +| `/ping` | 測試網路延遲。 | +| `/echo [文字]` | 讓機器人重複你說的話。 | --- -**開發者:** 唐宋 -**語言:** Python -**套件:** discord.py \ No newline at end of file +**開發者**:唐宋 + +**技術棧**:Python, Discord.py, JSON \ No newline at end of file