mosfez-xen-synth

A (soon to be created) microtonal-aware synth engine library for web.

Play the demo, it might not work. It's early days yet.

Installation

npm install mosfez-xen-synth or yarn add mosfez-xen-synth

Then you'll need to copy the files from node_modules/mosfez-xen-synth/public and put it in your projects public-facing root directory that will be accessible once deployed. e.g. if you are using Vite, put them in your Vite project's public directory. This library will make a request for libfaust-wasm.wasm and libfaust-wasm.data when it starts up, and will not work if those files can't be found.

Usage

import { MosfezXenSynth } from "mosfez-xen-synth/v0";

// the rest is TBC

Development

This library is written in typescript and Faust.

It is bundled with rollup, formatted with prettier, linted with eslint and tested with jest.

You will need node@16 or greater and yarn@1 installed globally. There's also:

• /demo: a demo site that compiles and uses the synth. This is set up as part of yarn prep.

Then you can run:

• yarn build to build the *.ts source files into *.js files and *.d.ts type files in /dist.
• yarn test to run tests using jest.
• yarn pretty to run the auto-formatter prettier.
• yarn lint to run the linter eslint.
• cd demo && yarn dev to run the demo.