# @ibrucekong/kapi

> kapi的Release包

Latest version **0.4.1** (published 2023-08-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @ibrucekong/kapi
pnpm add @ibrucekong/kapi
yarn add @ibrucekong/kapi
bun add @ibrucekong/kapi
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2023-08-17 |
| First published | 2023-05-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ~16.9.1 |
| Dependencies | 0 |
| Unpacked size | 861 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bruce Kong |
| Maintainers | ibrucekong |
| Keywords | kapi, wefamily, ibrucekong, Bruce Kong, 数字孪生, 虚拟仿真 |

## Links

- npm: https://www.npmjs.com/package/@ibrucekong/kapi
- Repository: https://gitee.com/wefamily/kapi-lib
- Homepage: https://wefamily.gitee.io
- Issues: https://gitee.com/wefamily/kapi-lib/issues
- npm.io page: https://npm.io/package/@ibrucekong/kapi

## Recent versions

- 0.4.1 (latest) — 2023-08-17
- 0.4.0 — 2023-08-07
- 0.3.1 — 2023-05-16
- 0.0.3 — 2023-05-16
- 0.0.2 — 2023-05-16
- 0.0.1 — 2023-05-16

## README

## KAPI
[kapi](https://kapi.brucekong.com)的Release包

### Installation
1、NPM安装
```shell
npm install @ibrucekong/kapi --save-dev
```

2、CDN引用
```html
<!-- unpkg -->
<script src='https://unpkg.com/@ibrucekong/kapi' type='application/javascript'></script>

<!-- jsdelivr -->
<script src='https://cdn.jsdelivr.net/npm/@ibrucekong/kapi' type='application/javascript'></script>
```

3、官网下载
```text
最新版本下载
https://kapi.brucekong.com/release/kapi.js

指定版本下载
https://kapi.brucekong.com/release/<your want to download version>/kapi.js
```

### Usage

#### 1 安装

```shell
npm install @ibrucekong/kapi --save
```

#### 2 引用

```shell
 1.browser引用
 <script src="[js_path]/kapi.js"</script>
 
 2.import 引用
 import "@ibrucekong/kapi" 
 或
 import KAPI from "@ibrucekong/kapi" 
 
 3.require引用
 require(["[js_path]/kapi.js"], (KAPI) => { [your code] })

```

#### 3 定义DOM

```html
<div id='kapi-container'></div>
```

#### 4 初始化

```javascript
// 1.初始化接口，配合 async
let kapi = await KAPI.build("<Your Auth Token>")
// 2.配置参数
let options = {
  server: '127.0.0.1:8080'   // 场景服务器地址
 }
// 3.初始化场景【下一步调用scene.ready()等待场景初始化好】
let scene = new kapi.Scene("kapi-container", options)
// 4.等待场景渲染好
let ready = await scene.ready()
```

#### Update Logs

- v0.0.1 实现创建web、vue
- v0.0.2 增加unpkg和jsdelivr引用
- v0.0.3 增加官网文件下载
- v0.3.1 与组件版本同步
- v0.4.0 增加动画模块，增强接口文档和稳定性

---
_Source: https://npm.io/package/@ibrucekong/kapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._