Skip to content

Latest commit

 

History

History
158 lines (112 loc) · 5.23 KB

File metadata and controls

158 lines (112 loc) · 5.23 KB

匹克携福机关

CI Docker Build Release License: MIT Rust Version Docker Image

简体中文 | English | 繁體中文 | 文言文 | Esperanto | Ελληνικά | संस्कृतम् | 火星语 | Kiswahili

以 锈 之術,造 匹克携福 雷迅 機關之器。

功用

  • 畫師訂閱:訂 匹克携福 畫師,新作自至。
  • 榜訂閱:訂 匹克携福 日榜、週榜、月榜。
  • 匹克携福 鏈接偵測:自偵訊息中 匹克携福 作品及使用者之鏈接。
    • 作品鏈接:傳完整圖像。
    • 使用者鏈接:供快速訂閱之選。
  • 智圖像處理
    • 自組多圖為冊。
    • 存圖像以減伺服器負荷及 匹克携福 接口 之呼。
    • 支援敏感內容(R-18、NSFW)之模糊處理。
  • 靈活調度:隨機輪詢間隔,擬真人之行,避速率限制。
  • 訪問控制
    • 管理員/擁有者之角色,以管群組聊天中之機關。
    • 可設「私」(僅邀)或「公」之模式。
  • 可自定
    • 每聊天之敏感標籤設置。
    • 可設之存儲及日誌。

安裝與用法

吾輩薦以 Docker 佈署,蓋其自理依存及環境設置也。

用 Docker Compose(薦)

  1. 複製庫藏:

    git clone https://github.com/icceey/pixivbot.git
    cd pixivbot
  2. 設機關:

    cp config.toml.example config.toml
    # 編 config.toml 填汝之令符
  3. 以 Docker Compose 啟之:

    docker compose up -d

    (根目錄含 docker-compose.yml 檔)

從源構建

若汝欲直接於機上行之:

  1. 前置要求

    • 锈(最新穩定版)
    • SQLite
  2. 複製並設

    git clone https://github.com/icceey/pixivbot.git
    cd pixivbot
    cp config.toml.example config.toml
    # 編 config.toml 填汝之憑據
  3. 構建並行

    cargo run --release

取所需令符

於設機關之前,須得二必需之令符:

1. 雷迅机关令符

  1. 於 雷迅 搜 @BotFather
  2. /newbot 並循指示
  3. 為汝機關擇名及使用者名
  4. 汝將得如 123456789:ABCdefGHIjklMNOpqrsTUVwxyz 之令符
  5. 將此令符抄至 config.tomltelegram.bot_token

2. 匹克携福刷新令符

薦法:用 get-pixivpy-token

得 刷新令符 後,抄至 config.tomlpixiv.refresh_token 欄。

⚠️ :妥保汝令符,勿提交至版本控制也!

設定

config.toml 或環境變數(前綴 PIX__,用雙底線)所支援之設定:

設定鍵 環境變數 說明 預設值
telegram.bot_token PIX__TELEGRAM__BOT_TOKEN 雷迅机关接口令符 ""
telegram.owner_id PIX__TELEGRAM__OWNER_ID 擁有者使用者 ID 0
telegram.bot_mode PIX__TELEGRAM__BOT_MODE publicprivate "private"
pixiv.refresh_token PIX__PIXIV__REFRESH_TOKEN 匹克携福授权刷新令符 ""
database.url PIX__DATABASE__URL 資料庫連線 URL sqlite:./data/pixivbot.db?mode=rwc
logging.level PIX__LOGGING__LEVEL 日誌級別(info、debug、warn) "info"
scheduler.cache_retention_days - 存儲保留日數 7

命令

使用者命令

  • /start - 啟機關
  • /help - 示助訊
  • /sub <id,...> [+tag1 -tag2] - 訂畫師
  • /subrank <mode> - 訂榜(daily、weekly、monthly)
  • /unsub <id,...> - 退訂畫師
  • /unsubrank <mode> - 退訂榜
  • /list - 列活訂閱
  • /settings - 示與管聊天設置(互動介面,具内嵌按鈕)
    • 切敏感內容模糊
    • 編輯敏感標籤
    • 編輯排除標籤
  • /cancel - 撤當前設置操作
  • /download <url|id> - 下載原圖(或回覆訊息)

管理員命令

  • /enablechat [chat_id] - 於聊天中啟機關(若處私模式)
  • /disablechat [chat_id] - 於聊天中止機關

擁有者命令

  • /setadmin <user_id> - 升使用者為管理員
  • /unsetadmin <user_id> - 降管理員為使用者
  • /info - 示機關系統狀態

貢獻

開發指南,見 CONTRIBUTING.md

許可

MIT

致謝

  • PixivPy:匹克携福 接口 實作之要參考。無其工,此專案不可成也。
  • AI 助手:特謝 GitHub Copilot、Claude 及 Gemini 於開發中所供技術支援及代碼生成。