https://github.com/galacean/engine-toolkit
Some out-of-the-box utility features based on the Galacean engine.
https://github.com/galacean/engine-toolkit
graphics-programming shaders toolkit typescript visual-effects webgl
Last synced: 4 months ago
JSON representation
Some out-of-the-box utility features based on the Galacean engine.
- Host: GitHub
- URL: https://github.com/galacean/engine-toolkit
- Owner: galacean
- License: mit
- Created: 2022-05-07T03:01:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T07:21:44.000Z (over 1 year ago)
- Last Synced: 2024-05-20T16:00:07.834Z (over 1 year ago)
- Topics: graphics-programming, shaders, toolkit, typescript, visual-effects, webgl
- Language: TypeScript
- Homepage: https://oasisengine.cn
- Size: 1.13 MB
- Stars: 72
- Watchers: 17
- Forks: 24
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCTOR.md
Awesome Lists containing this project
README
# Galacean Engine Toolkit
  [](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
- ๐ ย **[Stats](packages/stats)** - Statistics rendering data
- ๐ธ ย **[Controls](packages/controls)** - Some camera controllers
- ๐ฅ ย **[Tween](packages/tween)** - Library for tween animation
- ๐ซง ย **[FrameBufferPicker](packages/framebuffer-picker)** - Pixel-based object picking
- โก๏ธ ย **[Gizmo](packages/gizmo)** - Operation tools for transforming (displacement, rotation, scaling)
- ๐งญ ย **[Navigation Gizmo](packages/navigation-gizmo)** - Three-view & visualized operation for camera control
- ๐ฃ ย **[Waypoint](packages/way-point)** - control entity move along waypoint
- ๐ช ย **[Dynamic Bone](packages/dynamic-bone)** - use dynamic spring movement to enhance skeleton animation
- ๐ ย **[Lines](packages/lines)** - 2D Solid Line & Dash Line
- ๐ ย **[Auxiliary Lines](packages/auxiliary-lines)** - Draw wireframe for entity and component
- ๐ง๐ผ ย **[Skeleton Helper](packages/skeleton-viewer)** - Skeleton visualization
- โญ๏ธ ย **[Outline](packages/outline)** - Show outline of mesh renderers
- ๐ผ ย **[Geometry Sketch](packages/geometry-sketch)** - Convert geometry into texture && sketch normal and mesh wireframe
- ๐ฑ ย **[Input Logger](packages/input-logger)** - Outputs `keyboard` and `pointer` information in real time for developers
- ๐ฆ ย **[Draco](packages/draco)** - Support draco compressed mesh
### [Custom Materials](packages/custom-material)
- โ๏ธ ย **[Grid Material](packages/custom-material/src/grid)** - Infinity grid material
- ๐ณ ย **[Planar Shadow Material](packages/custom-material/src/planar-shadow)** - Two-pass shadow on the planar
- ๐ ย **[Bake PBR Material](packages/custom-material/src/bake-pbr)** - Bake texture with ibl lighting
- ๐ ย **[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.