1.0.0-alpha.0 โข Published 1 year ago
oasis-engine-tools-root v1.0.0-alpha.0
Oasis Engine Tools
Some useful tools that can be used in Oasis engine.
Tools
- ๐ ย baker - Off-Screen Rendering, to generate Spherical harmonics and IBL mipmaps
- ๐ ย atlas - Atlas tool for oasis engine
- โ๏ธ ย atlas-lottie - Transform lottie JSON file to atlas format in oasis engine. This tool will generate a folder which contains three files: a processed lottie JSON file, an atlas file and an image.
- โพ๏ธ ย color-dilation - Remove black borders from image.
The tools is published on npm with full typing support. To install, use:
npm install oasis-engine-tools
This will allow you to import tools entirely using:
import * as TOOLS from "oasis-engine-tools";
or individual classes using:
import { IBLBaker } from "oasis-engine-tools";
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
License
The engine is released under the MIT license. See LICENSE file.
1.0.0-alpha.0
1 year ago