Engine Toolkit

Some out-of-the-box utility features based on the Oasis engine Script and Material, welcome to enjoy!

Features

• 📊  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

• 📐  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

Materials

• 🗳  Planar Shadow Material - Two-pass shadow on the planar
• ⚔️  Grid Material - Infinity grid material

npm

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

npm install oasis-engine-toolkit

This will allow you to import toolkit entirely using:

import * as TOOLKIT from "oasis-engine-toolkit";

or individual classes using:

import { OrbitControl, FramebufferPicker } from "oasis-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 / 贡献指南 before submitting changes.

Build

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

Links

• Official Site
• Examples
• Documentation
• API References

License

The engine is released under the MIT license. See LICENSE file.