插件包部署说明

1. 插件部署说明

  • 开发者完成脚本编码调试之后,可将脚本按照本文描述的指导方法先制作插件包,即可通过APP在盒子内安装运行。

  • 也可点击下载插件生成工具,一键打包 >> 立即下载

    avatar

1.1 插件包格式

插件使用zip格式打包,使用zip或者7z工具压缩后,需要修改后缀名为“*.xrplugin”。 文件目录结构如下示,父目录下包括control和data两个子目录,control子目录中包含子文件control用来描述该插件包的名称、入口、版本、描述等信息。data子目录是python源码目录。

├── control │

  • └── control

  • └── data | └── fire.py

control文件采用json格式,示例和字段说明如下,

{
  "package": "datasniffer", 
  "entry": "fire.py", 
  "version": "V1.0.1", 
  "author": "mail@mail.com", 
  "description": "data pack capture analysis tool",
  "name": "插件展示名称"
}
字段 类型 是否必须 说明
package string 插件包名称。长度小于64个字节,只能包含数字或者大小写字母。
entry string 插件源码入口文件名称。长度小于64个字节,不能‘-’字符开头,不能包含#;+$%*!^/'"字符。
version string 插件版本。长度小于32个字节。
author string 插件作者。长度小于32个字节。
description string 插件描述。长度小于312个字节。
name string 插件展示名称。长度小于64个字节。
instruction string 插件说明。长度小于640个字节。
usage string 插件用法。长度小于640个字节。
date string 插件更新日期。长度小于40字节。