MoviePilot-Plugins 项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00003/article/details/139111545

MoviePilot-Plugins 项目教程

MoviePilot-Plugins MoviePilot官方插件市场项目地址: https://gitcode.com/gh_mirrors/mo/MoviePilot-Plugins

1. 项目目录结构及介绍

MoviePilot-Plugins 项目的目录结构如下：

MoviePilot-Plugins/
├── docs/
│   └── icons/
├── plugins/
│   └── v2/
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── package-v2.json

目录结构介绍

docs/: 存放项目文档和图标文件。
- icons/: 存放插件图标文件。
plugins/: 存放插件代码。
- v2/: 存放版本2的插件代码。
.gitignore: Git 忽略文件配置。
LICENSE: 项目许可证文件。
README.md: 项目说明文件。
package.json: 插件仓库中所有插件的概要信息。
package-v2.json: 版本2的插件概要信息。

2. 项目启动文件介绍

MoviePilot-Plugins 项目没有明确的启动文件，因为它是插件仓库，插件的启动和加载由 MoviePilot 主程序负责。插件的启动逻辑通常在插件代码的 __init__.py 文件中定义。

插件启动逻辑

每个插件的启动逻辑通常在插件目录下的 __init__.py 文件中定义。以下是一个简单的插件启动示例：

# plugins/example_plugin/__init__.py

class ExamplePlugin:
    def __init__(self):
        # 初始化插件
        pass

    def start(self):
        # 启动插件逻辑
        pass

# 插件实例化
plugin = ExamplePlugin()
plugin.start()

3. 项目的配置文件介绍

MoviePilot-Plugins 项目的配置文件主要包括 package.json 和 package-v2.json。这些文件用于定义插件的概要信息，包括插件的名称、版本、描述、图标等。

package.json

package.json 文件定义了插件仓库中所有插件的概要信息。以下是一个示例：

{
  "name": "MoviePilot-Plugins",
  "version": "1.0.0",
  "description": "MoviePilot 官方插件市场",
  "author": "jxxghp",
  "license": "GPL-3.0",
  "plugins": [
    {
      "name": "ExamplePlugin",
      "version": "1.0.0",
      "description": "示例插件",
      "icon": "http://example.com/icon.png"
    }
  ]
}

package-v2.json

package-v2.json 文件定义了版本2的插件概要信息。以下是一个示例：

{
  "name": "MoviePilot-Plugins-v2",
  "version": "2.0.0",
  "description": "MoviePilot 官方插件市场 - 版本2",
  "author": "jxxghp",
  "license": "GPL-3.0",
  "plugins": [
    {
      "name": "ExamplePluginV2",
      "version": "2.0.0",
      "description": "示例插件 - 版本2",
      "icon": "http://example.com/icon-v2.png"
    }
  ]
}

配置文件说明

name: 插件或插件仓库的名称。
version: 插件或插件仓库的版本号。
description: 插件或插件仓库的描述。
author: 插件或插件仓库的作者。
license: 插件或插件仓库的许可证。
plugins: 插件列表，包含每个插件的详细信息。
- name: 插件名称。
- version: 插件版本号。
- description: 插件描述。
- icon: 插件图标的URL。