# 配置 mm Plugin 插件

## 规则（Rules）

- plugin.json 位于 `app/{模块名}/plugin/{插件名}/plugin.json`
- `name` 字段全局唯一，与目录名一致
- `app` 字段指定所属应用名（如 sys、tool、user）
- `state: 1` 启用，`state: 0` 禁用

## 方法（Methods）

### 步骤1：编写 plugin.json 基础字段

```json
{
    "name": "my_plugin",
    "title": "我的插件",
    "description": "插件描述",
    "version": "1.0.0",
    "app": "sys",
    "author": "作者名",
    "main": "./index.js",
    "state": 1,
    "show": 0,
    "icon": "/sys/my_plugin/img/logo.png"
}
```

### 步骤2：按需添加配置选项

如果插件需要可配置的参数（如API密钥），在 `options` 数组中定义：

```json
"options": [
    {
        "group": "默认",
        "name": "apiKey",
        "title": "API密钥",
        "type": "string",
        "control": "input",
        "tip": "提示信息",
        "description": "详细说明",
        "default": "",
        "value": ""
    }
]
```

### 步骤3：按需添加命令和页面

```json
"cmd": "sys.my_plugin",
"pages": [
    { "name": "首页", "url": "/sys/my_plugin" }
]
```

## 技巧（Tips）

- `options` 中的配置项会在管理后台自动生成配置界面，无需额外开发
- `cmd` 字段用于命令行快捷访问，格式为 `{app}.{plugin_name}`
- `icon` 字段指向插件图标文件路径