Widget Core

让构建实时互动小工具变得简单✨

!logo

概览 Overview

@intous/widget-core是对@hujiang/widget-sdk的彻底重写 设计原则和主要目标如下：
* 通讯能力基于MQTT协议实现 去除了对CC Server的依赖
* 使用web技术替换原SDK中部分由原生端实现的功能
* 提供了比原SDK更丰富的多人互动能力 赋能更复杂的业务场景
* Host-independent, upstream-agnostic——即：不依赖某一具体宿主 无需关心上游来源 上下文信息由使用方提供
* 提供更完整的类型信息、更友好的开发体验 并支持TypeScript codebase
* 使用现代的ES Module标准 以支持Tree Shaking 减少最终bundle体积
* 不与原SDK API兼容（如：不再使用cctalk这个的命名空间 去除了上下麦、举手相关的与CC业务高度耦合的功能）
* 计划通过适配层发行基于Widget Core的@hujiang/widget-sdk v2.0版本 新版本将尽可能于旧版本保持API兼容 最大程度减低现有Widget App的改造成本
* 之后新的Widget App可以将直接采用Widget Core开发

安装 Installation

通过 npm 安装：
``bash
npm install @intous/widget-core
`

或通过 yarn 安装：
`bash
yarn add @intous/widget-core
`

安装前可以考虑通过阿里云镜像加速

在.npmrc文件中添加以下配置：
`
@intous:registry = https://registry.npmmirror.com
`

或在.yarnrc文件中添加以下配置：
`
"@intous:registry" "https://registry.npmmirror.com"
``

使用方法 Usage