Engine Toolkit
Some out-of-the-box utility features based on the Oasis engine Script
, welcome to enjoy!
Features
-
๐ธ Controls - Some camera controllers - ๐ซง FrameBufferPicker - Pixel-based object picking
-
๐ Stats - Statistics rendering data
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, Stats } 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
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 bootstrap
Then, to build the source, using npm:
npm run b:all
Links
License
The engine is released under the MIT license. See LICENSE file.