Some out-of-the-box utility features based on the Galacean engine Script
and Material
, welcome to enjoy!
-
๐ Stats - Statistics rendering data
-
๐ธ Controls - Some camera controllers
-
๐ซง FrameBufferPicker - Pixel-based object picking
-
โก๏ธ Gizmo - Operation tools for transforming (displacement, rotation, scaling)
-
๐งญ Navigation Gizmo - Three-view & visualized operation for camera control
-
๐ฃ Waypoint - control entity move along waypoint
-
๐ช Dynamic Bone - use dynamic spring movement to enhance skeleton animation
-
๐ Lines - 2D Solid Line & Dash Line
-
๐ Auxiliary Lines - Draw wireframe for entity and component
-
๐ง๐ผ Skeleton Helper - Skeleton visualization
-
โญ๏ธ Outline - Show outline of mesh renderers
-
๐ผ Geometry Sketch - Convert geometry into texture && sketch normal and mesh wireframe
-
๐ฑ Input Logger - Outputs
keyboard
andpointer
information in real time for developers
- โ๏ธ Grid Material - Infinity grid material
- ๐ณ Planar Shadow Material - Two-pass shadow on the planar
- ๐ Bake PBR Material - Bake texture with ibl lighting
The toolkit is published on npm with full typing support. To install, use:
npm install @galacean/engine-toolkit
This will allow you to import toolkit entirely using:
import * as TOOLKIT from "@galacean/engine-toolkit";
or individual classes using:
import { OrbitControl, FramebufferPicker } from "@galacean/engine-toolkit";
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 / ่ดก็ฎๆๅ before submitting changes.
prerequisites:
- Node.js v15.0.0+ and NPM (Install Node.js By official website)
- PNPM (Install Pnpm globally by
npm install -g pnpm
)
First, you need to install the dependencies:
pnpm install
Then, to build the source, using npm:
npm run b:all
The engine is released under the MIT license. See LICENSE file.