# [three-app-sdk](https://www.npmjs.com/package/three-app-sdk)

[![version](https://img.shields.io/npm/v/three-app-sdk.svg)](https://www.npmjs.com/package/three-app-sdk) ![downloads](https://img.shields.io/npm/dm/three-app-sdk.svg) ![LICENSE](https://img.shields.io/npm/l/three-app-sdk.svg) ![repo-types](https://img.shields.io/npm/types/three-app-sdk.svg) ![minzip](https://img.shields.io/bundlephobia/minzip/three-app-sdk)

## 用途

3D 通用组件库sdk。

## 特性

- 基于 TypeScript 开发，不限前端框架。
- 默认全局光照环境，3D模型材料限定使用物理材质或者标准材质
- 3D模型类型限定使用glb类型
- 支持浏览器窗口失焦运行
- 支持物理环境
- 支持框架内资源自动销毁

## 安装

通过 npm 下载安装代码

```bash
$ npm i three-app-sdk
```

通过 yarn 下载安装代码

```bash
$ yarn add three-app-sdk
```

通过 pnpm 下载安装代码

```bash
$ pnpm i three-app-sdk
```

如何使用

```language
//创建一个应用
import { Application } from 'three-app-sdk'
const el: any = document.getElementById('app')

const app = new Application(el, {
  enableEffectComposer: true,
  hideAxes: false,
  hideGrid: false
})
app.start()
```

```bash
docs目录为sdk教程，使用vite运行
```

```bash
examples为例子目录，使用vite运行
```

[更新日志](CHANGE.md)