先看项目与功能地图,再阅读目标仓库的 AGENTS.md、README 和相关开发文档。Wiki 提供入门和合同入口,不复制不断变化的全部接口清单。
不要直接在生产实例上开发和测试。为开发数据指定独立配置目录,使用对应项目的虚拟环境或包管理器,外部站点、真实下载器和媒体文件的写操作单独验收。
当前 V3 运行依赖 Python 3.14+、uv 0.12.5+,依赖声明与锁定分别在 pyproject.toml、uv.lock。普通独立检出的开发环境从仓库根目录执行:
uv sync --locked
已有共享运行环境与隔离测试环境时,先按工作区约定选择,不要覆盖正在运行的环境。测试必须使用临时 CONFIG_DIR,不要读取生产 app.env 或数据库。
| 文档 | 用途 |
|---|---|
| 开发环境 | 锁定依赖、平台与共享环境 |
| 架构总览 | 分层、数据流和生命周期 |
| 规则入口 | 编码、命名、注释、接口、持久化与协作 |
| 测试说明 | 隔离、执行范围和 CI 证据 |
| CLI | 安装、运行、诊断与管理命令 |
主程序已按 foundation、domain、application、runtime、adapters 等职责分层。app.core、app.helper、app.utils 是已登记旧插件的兼容入口,不应在主程序中重建实体目录或继续新增旧路径依赖。
前端为 Vue 3、Vuetify 3、TypeScript 与 Vite 项目,当前最低 Node.js 20.19,推荐 Node.js 24,固定使用 Yarn 1 和 yarn.lock。先按前端 README连接独立开发后端。
新插件面向 V3,优先使用 app.sdk 稳定合同;插件实现、索引、版本与依赖声明必须同步。入口见插件开发。
插件的完整教程、生命周期、数据库访问、事件、通知、存储、工作流、Agent 与前端扩展统一在插件开发指南及FAQ维护。
MoviePilot-Build 拥有站点资源生成、认证配置和 resource_versions.toml。MoviePilot-Resources 发布生成后的 resources.v3/,不要手工修改已编译文件充当源码修复。开发入口:Build README、站点 API 接入合同、脱敏采集包协议。
提交站点样本前必须检查脱敏,不提交 Cookie、Passkey、授权头或完整私有下载地址。采集器的脱敏声明不能代替人工核查。
| 方向 | 开发与验证入口 |
|---|---|
| Rust / PyO3 加速 | MoviePilot-Rust,构建 wheel 后回主程序验证 Python 接入与回退 |
| iOS | App 开发说明和前端集成,区分模拟器、IPA、签名与真机结果 |
| 中心服务 | Server,独立配置、数据库、部署和推送合同 |
| OCR | OCR,同步验证主程序调用的 HTTP 协议 |
| 用户文档 | 文档共建,使用 Wiki.js 格式与链接检查 |
各仓库规则优先于本页的概览;完整接口、版本和命令以当前对应分支为准。