# 一、基本插件文件結構 >[success] 插件文件夾由主文件夾、插件配置文件、插件源碼文件和其它資源文件組成 這里以一個簡單的helloworld插件舉例，你也可以通過插件市場直接下載helloworld插件樣例查看。  ```shell ├── helloworld # 插件文件夾名稱 │ ├── config.json # 插件配置文件 │ └── helloworld.py # 插件主程序文件 ``` <br> # 二、文件名命名規范 >[info] 文件夾名稱為`helloworld`，那么插件程序名稱必須為`helloworld.py`  <br> # 三、config文件規范 >[info] 我們可以看到插件文件夾里有一個config.json文件，這個文件是用于配置插件的各項屬性的，比如插件是否自啟動，插件是否打印出debug信息，插件的觸發詞等等，詳細的插件各項屬性請查看下列屬性表單。  ```json { "name": "helloworld", "triggerwords":["Hello", "你好世界"], "IsEnable": true, "IsSystem": false, "AutoLoader": false, "icon":"1", "displayName": "基本的Hello World", "description": "這里寫簡介，比如'這是一個Hello World文檔'", "version": "1.0.1", "updateTime":"2022-06-22 13:25:10" } ``` | 屬性 | 功能 | 可選值 | | --- | --- |---| | name | 插件名，需要與插件文件夾名稱一致 | "helloworld" | | triggerwords | 插件的觸發詞 | ["觸發詞1","觸發詞2"] | | IsEnable| 是否啟用插件 | true,false | | IsSystem| 是否為系統插件 | false,true | | AutoLoader| 是否自動加載 | false,"start" | | icon| 默認圖標 | "1" | | displayName| 插件的顯示名 | "插件名稱" | | description| 插件的簡介 | "插件的簡介" | | version| 插件版本 |"1.0.1" | | updateTime| 更新時間 | "2022-06-22 13:25:10" | <br> # 四、插件主程序文件規范 >[info] 打開`helloworld.py`文件，這是插件的主程序文件，它在我們的系統里是以類(class)的方式提供的,你編寫的插件的所有功能都是從這里開始的。  `helloworld.py`源碼 ```python from MsgProcess import MsgProcess, MsgType class helloworld(MsgProcess): def Text(self, message): data="你好世界~ 我是智能小美" self.send(MsgType.Text, Receiver='Screen', Data=data) ``` >[warning] 這段代碼建議手動敲出來不要復制，復制會導致編碼錯誤，尤其是Windows平臺和Linux平臺的CRLF和LF格式問題。 >[info] 請在條件允許的情況下手動將代碼輸入一遍 這段代碼表示將字符串`data`的內容以`MsgType.Text`類型發送到 `Screen`也就是前端的屏幕 如果你對`send()`函數不理解請前往[插件消息機制](http://docs.16302.com/2987119)了解。 # 五、最終效果