Skip to content

integrate mostly-harmless-js into examples #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MeijisIrlnd merged 4 commits into from
Sep 12, 2025
Merged

integrate mostly-harmless-js into examples #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a51f4c9
use mostly-harmless-js in gain example
Sep 12, 2025
d491e38
use mostly-harmless-js in delay example
Sep 12, 2025
602af45
user mostly-harmless-js in synth example
Sep 12, 2025
18fd3f9
update readme, untrack package-locks
Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ should you need some convenience helpers and basic audio features.

The goal of the framework was to provide the bare minimum we (as in SLM Audio) need to write a plugin - and as such we
don't provide any kind of gui framework of our own.
We do, however, provide a thin wrapper around [choc](https://github.com/Tracktion/choc)'s WebView, and plan to implement
We do, however, provide a thin wrapper around [choc](https://github.com/Tracktion/choc)'s WebView, with an accompanying
minimal helper library [mostly-harmless-js](https://www.npmjs.com/package/@slm-audio/mostly-harmless-js) and plan to
implement
similar minimal wrappers around a couple of other frameworks.<br>
We also provide an interface with hooks for you to implement your framework of choice,
in `mostly_harmless::gui::IEditor`.
Expand All @@ -38,7 +40,10 @@ in `mostly_harmless::gui::IEditor`.

### First Steps

Firstly, we'd recommend taking a look in the `examples` directory for a real-world use case, and the FX Plugin Tutorial in the docs directory, which talks you through some of the framework's core ideas, and how to set up a simple gain plugin project. We also provide a Python script to generate the boilerplate needed for a new project for you, found in the root directory.
Firstly, we'd recommend taking a look in the `examples` directory for a real-world use case, and the FX Plugin Tutorial
in the docs directory, which talks you through some of the framework's core ideas, and how to set up a simple gain
plugin project. We also provide a Python script to generate the boilerplate needed for a new project for you, found in
the root directory.

Usage:

Expand Down Expand Up @@ -223,7 +228,8 @@ mostly harmless depends on the following libraries:

## Credits

This framework wouldn't exist without the advice, moral support and help
This framework wouldn't exist without the contributions of [Ryan Jeffares](https://github.com/ryanjeffares), advice,
moral support and help
of [mthierman](https://github.com/mthierman), [Ben Vining](https://github.com/benthevining), [Signalsmith](https://signalsmith-audio.co.uk/)
and the legions of incredible people in [The Audio Programmer Discord](https://discord.gg/v5Rs8h6aGF).<b>

Expand Down
Loading
Loading