貢獻指南

感謝你對 karin-plugin-kkk 感興趣！我哋需要你嘅幫助來令呢個項目變得更好。

無論係修復 Bug、添加新功能，定係改進文檔，我哋都非常歡迎。

準備工作

喺開始之前，請確保你嘅開發環境滿足以下要求：

• Node.js: >= 22
• pnpm: >= 9
• Git: 版本控制工具

項目結構

本項目採用 Monorepo 結構，主要包含以下部分：

• packages/core: 核心插件代碼 (karin-plugin-kkk)，包含主要業務邏輯。
• packages/template: React SSR 渲染器，生成 HTML 文件。
• packages/amagi: 接口庫 (Git Submodule)，處理各平台嘅 API 請求與簽名。
• packages/docs: 文檔站點，基於 Next.js 同 Fumadocs。

架構說明

插件在 Karin 中的位置

karin-plugin-kkk 係 Karin 框架嘅一個功能插件，遵循 Karin 嘅插件規範開發。

消息處理流程

當用戶在群傾偈中發送包含平台連結嘅消息時，插件嘅處理流程如下：

核心模塊說明

Apps 命令層 - 負責註冊 Karin 命令，監聽消息並分發到對應嘅平台處理器。

src/apps/
├── tools.ts      # 視頻解析命令（抖音/B站/快手/小紅書）
├── push.ts       # 動態推送任務
├── qrlogin.ts    # 掃碼登錄功能
├── admin.ts      # 管理員命令
├── help.ts       # 幫助信息
└── update.ts     # 插件更新

Platform 平台層 - 每個平台獨立封裝，包含連結解析、數據獲取、評論處理等。

src/platform/
├── douyin/       # 抖音
├── bilibili/     # B站
├── kuaishou/     # 快手
└── xiaohongshu/  # 小紅書

Module 工具層 - 提供配置管理、數據庫操作、API 服務、網絡請求等通用功能。

src/module/
├── config/       # 配置管理
├── db/           # 數據庫操作
├── server/       # API 服務
└── utils/        # 工具函數

數據流向

開發流程

# 替換為你嘅 GitHub 用戶名
git clone --recursive https://github.com/你嘅用戶名/karin-plugin-kkk.git

# 或者如果你已經克隆咗倉庫但冇子模塊
git submodule update --init --recursive

pnpm install

<type>(<scope>): <subject>

常見問題

如何更新子模塊？

如果你發現 packages/amagi 落後於上游，可以使用以下命令更新：

git submodule update --remote

遇到 TypeScript 類型錯誤？

嘗試重新構建整個項目或重新安裝依賴：

pnpm install
pnpm build