Discord Pycord Template

Python Discord Bot(Pycord版) 基礎骨架 拜託給個 start 拉>>>

建置方法 / 演示 影片

---

🏠 目錄

• Discord Pycord Template
  • 建置方法 / 演示 影片
  • 🏠 目錄
  • ⚡ Introduction 簡介
  • 🚀 食用方法
    • 📥 安裝
    • 🔧 配置
    • 〽️ 執行
  • 🔩 Folder structure 資料夾結構
  • 📜 使用函式庫
    • 📄 開發中使用
  • 生成多語言文件
  • ✏️ 內建功能
    • 📕 事件
    • 📗 指令
      • slash_command
      • message_command
      • context_menus
      • user_commands
  • 📰 貢獻者
  • 📝 License

---

⚡ Introduction 簡介

提供一個基本骨架，快速的開始一隻新的機器人開發

• Cog 架構
• For (初學者/開發者)
• Bot 指令/類別/功能 分離
• I18n 多語言支持 (使用 gettext 製作實現)
• Logging 日誌系統

🚀 食用方法

食用要求:

1. python 版本 >= 3.8
2. 空腹 （怕你吃到吐）😑

📥 安裝

• pip: 將函式庫直接下載到全域

  • 生產中使用

    pip install -r requirements/prod.txt

  • 開發中使用

    pip install -r requirements/dev.txt

• venv: 使用 python 內建函式庫 venv

  python -m venv env

  • 生產中使用

    pip install -r requirements/prod.txt

  • 開發中使用

    pip install -r requirements/dev.txt
    pip install -r tool/requirements.txt

🔧 配置

將 .env.example 重新命名為 .env 並自行修改設定檔裡的資料。

〽️ 執行

使用 -m 方式執行

python -m bot

或者直接使用 python 執行

python start.py

🔩 Folder structure 資料夾結構

/                     # 根目錄
├ 📂 .vscode               # 編輯器設定
│ ├ extensions.json       # vscode 建議插件
│ └ settings.json         # vscode 插件設定
├ 📂 bot                   # 原代碼資料夾
│ ├ 📂 cogs                  # cog 資料夾
│ │ ├ 📂 admin                 # 管理類 cog 存放
│ │ │ ├ 📂 locales              # 多語言資料
│ │ │ │ └ [en-US].po            # *.po 為上層目錄中所有 .py 檔案的翻譯文件
│ │ │ ├ clear.py              # 清除訊息指令程式
│ │ │ └ [filename].py         # 其它的 cog 檔案 （請遵循 ./clear.py 的檔案架構）
│ │ └ 📂 [cog dir]             # 其它的 cog 資料夾 （請遵循 ./admin 的資料夾結構）
│ ├ 📂 core                  # 核心功能
│ │ ├ bot.py                # 機器人核心程式
│ │ ├ events.py             # 核心事件
│ │ ├ commands.py           # 核心指令
│ │ ├ i18n.py               # 多語言支持
│ │ ├ logging.py            # 日誌支持
│ │ └                       # 可依自己需求添加其他檔案
│ ├ 📂 utils                 # 小型函式庫
│ │ ├ __init__.py           # 程式導入點
│ │ ├ base.py               # 自訂擴展
│ │ ├ util.py               # 雜項函式
│ │ └                       # 可依自己需求添加其他檔案
│ ├ __init__.py           # 主程式導入點
│ └ __main__.py           # 主程式進入點
├ 📂 env                   # 如使用 venv 將會生成該資料夾存放函式庫文件
├ 📂 logs                  # 日誌存放
│ └ [filename].log        # 日誌
├ 📂 requirements          # 日誌存放
│ ├ prod.txt              # 生產用函式庫使用
│ └ dev.txt               # 開發用函式庫使用
├ 📂 tool                 # 開發工具
│ ├ i18n.py               # 製作 `.po` 檔案 (進行翻譯)
│ └ requirements.txt      # tool 中所需要的函數庫
├ .dockerignore         # docker 忽略設定檔
├ .editorconfig         # editorconfig 設定檔
├ .env                  # 機密文件
├ .env.example          # 機密文件範例
├ .flake8               # python-flake8
├ .gitattributes        # git 屬性設定
├ .gitignore            # git 文件規則設定
├ .prettierrc.yaml      # prettier 設定檔
├ Dockerfile            # Docker 編譯設定
├ LICENSE               # MIT License 希望您可以保留該文件讓大家可以更了解這個模板
└ README.md             # 本文件

📜 使用函式庫

函式庫名	描述
py-cord	Discord API 支援
python-dotenv	讀取 .env 檔案
rich	日誌寫入與顯示
polib	生成 i18n 檔案

📄 開發中使用

函式庫名	描述
black	Python 格式化器
flake8	Python 程式統一

生成多語言文件

若須手動生成可以使用以下指令，其中 -s 表示模式切換至 多語言檔案生成模式, -l 表示需生成的語言(若都需要可使用 *)，-f 表示包含的資料夾，-r 表示遞歸可向深度的資料夾進行生成。其他更多指令可使用 python -m bot --help 查詢。

python -m bot -s -l en-US -f bot/cogs -r

✏️ 內建功能

📕 事件

1. on_ready
   打印出開機訊息
2. on_application_command
   slash_command 日誌
3. on_application_command_error
   slash_command 錯誤日誌
4. on_command
   message command 日誌
5. on_command_error
   message command 錯誤日誌

📗 指令

slash_command

1. delete
   清除特定訊息。( 從訊息 ID )
   用戶執行權限需求 -> manage_messages
2. purge
   清除多個訊息。
   用戶執行權限需求 -> manage_messages
3. uptime
   獲取機器人上線時長
   用戶執行權限需求 -> 無

message_command

1. reload
   重加載所有 cog
   用戶執行權限需求 -> bot owner

context_menus

無

user_commands

無

📰 貢獻者

這個項目的存在要感謝所有做出貢獻的人。

📝 License

MIT © a3510377