For additional flexibility and extensibility, the Elementary engine is also available via the embedded SDK for custom native integrations. The embedded SDK is not yet publicly available, please email [email protected] for details.
To start, you'll first need to install the Elementary npm package:
npminstall --save @nick-thompson/elementary
If you're building an app for the browser, then that's it, you're done! If you're building at the command line for a desktop application, see below.
You can also install the appropriate binaries for your platform manually, downloading from the releases page on this repository, and unpacking the zip file to a directory of your choosing.
Here in the examples/ directory you'll find a small set of example projects aiming to provide a brief introduction to various functionality. Each example can be invoked on its own:
$ cd examples/
$ elementary 00_HelloSine/
And of course you can open these example files, poke around, and edit as you like!
Elementary is available for use under either the PolyForm Strict 1.0.0 license, or under the terms of a commercial license, at your choosing. Please see LICENSE.md in the npm package for the full text of the PolyForm Strict 1.0.0 license, and please contact [email protected] to inquire for a commercial license.
For use under the PolyForm Strict 1.0.0 license you must also include a note, "Made with Elementary Audio" either somewhere on the visible part of your application or webpage, or within the documentation.