# 快速开始

中控插件是依赖于三思通用中控(下文中简称中控)存在的，是为中控提供功能扩展的一种技术方案，可以在不重启中控的基础上为其添加功能扩展。通过加载不同类型的插件进行组合，满足不同场景的使用需求，例如：会议室、体育场、指挥中心、展厅等。

插件开发底层技术为 Vue + Vuex + Element-Plus，项目默认采用 npm 进行管理，支持切换到 pnpm 或者 yarn，需要配置 Node 环境(Node 版本 >= 16，推荐使用 16.18.1)，推荐使用 WebStorm 或者 VS Code 等 IDE 工具进行开发，建议在实际开发之前先配置好 Node 环境和相关开发工具。

⚠️注意：开始之前请先安装 Node 环境(推荐版本 16.18.1)，并且准备好开发工具(推荐 WebStorm 或者 VS Code)。

# 安装中控

下载三思通用中控 (opens new window)最新版本。
根据部署手册安装中控
根据使用手册创建一个新项目

# 安装框架

npm i sccs -g

# 初始化项目

# 创建空目录，并进入
mkdir my_plugin
cd my_plugin

# 初始化项目
sccs init

# 根据提示填写插件信息，生成结束后，插件名称、ID 等信息可以在项目根目录的 main.json 文件中修改

? 插件名称: 我的插件
? 插件标识: 1B96551SSSDAD4C2D4
? 插件版本: 1.0.0
? 插件描述: 测试用插件

# 安装项目依赖
npm install

# 等待命令执行结束

# 调试项目

调试项目需要打开中控，在中控中进行，运行下面命令后，中控里面会自动追加一个调试插件，可以通过调试插件观察效果。

sccs dev

# 编译项目

编译后的项目会生成在项目根目录下的 release 目录中，后缀名为 .plug

sccs build

# 发布项目

发布项目会自动编译项目然后提交到云平台上，需要按照以下步骤操作

# 本地发布

在三思云平台 (opens new window)上申请发布用到 token
在环境变量中添加 SANSI_CLOUD_PLUGIN_TOKEN 这个环境变量，值为申请到的 token 字符串
运行 sccs publish --open

# CI 自动发布

在云平台上申请发布用到 token
在 gitlab 仓库的环境变量中添加 SANSI_CLOUD_PLUGIN_TOKEN 这个环境变量，值为申请到的 token 字符串
在 CI 流程中添加 sccs publish --open 进行发布

⚠️注意： sccs publish --open 表示公开发布。
取消 --open 参数 sccs publish，或者声明关闭 sccs publish --open false 均表示该版本不公开发布。
非公开发布的版本，不可以在中控在线插件中直接搜索到，需要登录云平台进行查看下载或者通过分享链接进行下载，之后通过本地进行加载。

申请 Token

配置 CI 变量

# 配置功能

# 查看当前配置

sccs config list

# 获取远程仓库地址

sccs config --get-registry

# 设置远程仓库地址

如果不使用默认远端发布地址，可以使用该功能进行配置。

sccs config --set-registry http://127.0.0.1:8888

插件规范 →