Some out-of-the-box utility features based on the Oasis engine Script and Material, welcome to enjoy!
- 🛸 Controls - Some camera controllers
- 🫧 FrameBufferPicker - Pixel-based object picking
- 📊 Stats - Statistics rendering data
- 🖇 Auxiliary Lines - Draw wireframe for entity and component
- 🗳 Planar Shadow Material - Two-pass shadow on the planar
- 🧍🏼 Skeleton Helper - Skeleton visualization
- ➡️ Gizmo - Operation tools for transforming (displacement, rotation, scaling)
- ⭕️ Outline - Show outline of mesh renderers
- 📐 Lines - 2D Solid Line & Dash Line
The toolkit is published on npm with full typing support. To install, use:
npm install oasis-engine-toolkitThis will allow you to import toolkit entirely using:
import * as TOOLKIT from "oasis-engine-toolkit";or individual classes using:
import { OrbitControl, FramebufferPicker, Stats } from "oasis-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.
If you don't already have Node.js and NPM, go install them. Then, in the folder where you have cloned the repository, install the build dependencies using npm:
npm run bootstrapThen, to build the source, using npm:
npm run b:allThe engine is released under the MIT license. See LICENSE file.