npm package: @galacean/engine-toolkit-root
Description: <a href="https://www.npmjs.com/package/oasis-engine-toolkit"><img src="https://img.shields.io/npm/v/oasis-engine-toolkit"/></a> ![npm-size](https://img.shields.io/bundlephobia/minzip/oasis-engine-toolkit) ![npm-download](https://img.shields.io/npm/dm/oasi
Latest version: 1.4.0-beta.1

# Galacean Engine Toolkit

<a href="https://www.npmjs.com/package/oasis-engine-toolkit"><img src="https://img.shields.io/npm/v/oasis-engine-toolkit"/></a> ![npm-size](https://img.shields.io/bundlephobia/minzip/oasis-engine-toolkit) ![npm-download](https://img.shields.io/npm/dm/oasis-engine-toolkit) [![codecov](https://codecov.io/gh/oasis-engine/engine/branch/main/graph/badge.svg?token=KR2UBKE3OX)](https://codecov.io/gh/oasis-engine/engine-toolkit)

Some out-of-the-box utility features based on the [Galacean engine](https://github.com/galacean/engine) `Script` and `Material`, welcome to enjoy!

## Features

- 📊 &nbsp;**[Stats](packages/stats)** - Statistics rendering data

- 🛸 &nbsp;**[Controls](packages/controls)** - Some camera controllers
- 🎥 &nbsp;**[Tween](packages/tween)** - Library for tween animation
- 🫧 &nbsp;**[FrameBufferPicker](packages/framebuffer-picker)** - Pixel-based object picking
- ➡️ &nbsp;**[Gizmo](packages/gizmo)** - Operation tools for transforming (displacement, rotation, scaling)
- 🧭 &nbsp;**[Navigation Gizmo](packages/navigation-gizmo)** - Three-view & visualized operation for camera control
- 🛣 &nbsp;**[Waypoint](packages/way-point)** - control entity move along waypoint
- 🪁 &nbsp;**[Dynamic Bone](packages/dynamic-bone)** - use dynamic spring movement to enhance skeleton animation

- 📐 &nbsp;**[Lines](packages/lines)** - 2D Solid Line & Dash Line
- 🖇 &nbsp;**[Auxiliary Lines](packages/auxiliary-lines)** - Draw wireframe for entity and component
- 🧍🏼 &nbsp;**[Skeleton Helper](packages/skeleton-viewer)** - Skeleton visualization
- ⭕️ &nbsp;**[Outline](packages/outline)** - Show outline of mesh renderers
- 🖼 &nbsp;**[Geometry Sketch](packages/geometry-sketch)** - Convert geometry into texture && sketch normal and mesh wireframe
- 🖱 &nbsp;**[Input Logger](packages/input-logger)** - Outputs `keyboard` and `pointer` information in real time for developers
- 📦 &nbsp;**[Draco](packages/draco)** - Support draco compressed mesh

### [Custom Materials](packages/custom-material)

- ⚔️ &nbsp;**[Grid Material](packages/custom-material/src/grid)** - Infinity grid material
- 🗳 &nbsp;**[Planar Shadow Material](packages/custom-material/src/planar-shadow)** - Two-pass shadow on the planar
- 🍞 &nbsp;**[Bake PBR Material](packages/custom-material/src/bake-pbr)** - Bake texture with ibl lighting
- 🍞 &nbsp;**[Shader Lab](packages/shaderlab)** - a declarative language for creating shader

## npm

The toolkit is published on npm with full typing support. To install, use:

```sh
npm install @galacean/engine-toolkit
```

This will allow you to import toolkit entirely using:

```javascript
import * as TOOLKIT from "@galacean/engine-toolkit";
```

or individual classes using:

```javascript
import { OrbitControl, FramebufferPicker } from "@galacean/engine-toolkit";
```

## Contributing

Everyone is welcome to join us! Whether you find a bug, have a great feature request or you fancy owning a task from the road map feel free to get in touch.

Make sure to read the [Contributing Guide](.github/HOW_TO_CONTRIBUTE.md) / [贡献指南](https://github.com/galacean/engine/wiki/%E5%A6%82%E4%BD%95%E4%B8%8E%E6%88%91%E4%BB%AC%E5%85%B1%E5%BB%BA-Oasis-%E5%BC%80%E6%BA%90%E4%BA%92%E5%8A%A8%E5%BC%95%E6%93%8E) before submitting changes.

## Build

prerequisites:

- [Node.js v15.0.0+](https://nodejs.org/en/) and NPM (Install Node.js By official website)
- [PNPM](https://pnpm.io/) (Install Pnpm globally by `npm install -g pnpm`)

First, you need to install the dependencies:

```sh
pnpm install
```

Then, to build the source, using npm:

```sh
npm run b:all
```

## Links

- [Official Site](https://oasisengine.cn)
- [Examples](https://oasisengine.cn/#/examples/latest/skeleton-viewer)
- [Documentation](https://oasisengine.cn/#/docs/latest/cn/install)
- [API References](https://oasisengine.cn/#/api/latest/core)

## License

The engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.