diff --git a/README.md b/README.md index 3748a44..40dd4a8 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,34 @@ ## dm-Whammy -A mono pitchshift effect written in Rust. - -The effect can be compiled to a [MOD devices](https://moddevices.com/), VST3 or CLAP plugin. -VST is a trademark of Steinberg Media Technologies GmbH, registered in Europe and other countries. - -VST trademark +A mono pitchshift effect written in Rust inspired by the classic DigiTech Whammy©. The effect can be compiled to a [MOD audio](https://mod.audio/), VST3 or CLAP plugin. ## Table of contents: -- [Download VST3 and CLAP plugin](#Download-VST3-and-CLAP-plugin) -- [MOD devices installation](#MOD-devices-installation) -- [Other plugin formats](#Other-plugin-formats) +- [VST3 and CLAP installation](#VST3-and-CLAP-installation) +- [MOD installation](#MOD-installation) +- [Copyright notices](#Copyright-notices) -## Download VST3 and CLAP plugin +## VST3 and CLAP installation -You can download the VST3 and CLAP plugins for Linux, Windows and macOS from the [release page](https://github.com/davemollen/dm-Whammy/releases). +You can download the VST3 and CLAP plugins for Linux, Windows and macOS from the [releases page](https://github.com/davemollen/dm-Whammy/releases). On macOS you may need to [disable Gatekeeper](https://disable-gatekeeper.github.io/) as Apple has recently made it more difficult to run unsigned code on macOS. -If you want to build the plugin on your own machine, check out the [nih-plug readme](https://github.com/robbert-vdh/nih-plug). +If you want to build the plugin on your own machine check out the [nih-plug repository](https://github.com/robbert-vdh/nih-plug) for instructions. -## MOD devices installation +## MOD installation This plugin is not yet in the MOD Audio plugin store. -However, you can find a build of the plugin for the MOD Dwarf at [./lv2/dm-Whammy.lv2](./lv2/dm-Whammy.lv2/). Copy this file to your MOD devices' plugin folder. If you want a build for MOD Duo or MOD Duo X you'll need to build the plugin yourself for now. For more information about building this plugin for your MOD device, see [these instructions](https://github.com/moddevices/mod-plugin-builder). +However, you can download the latest MOD Dwarf build from the [releases page](https://github.com/davemollen/dm-Whammy/releases). + +If you want to build the plugin on your own machine check out the [mod-plugin-builder repository](https://github.com/moddevices/mod-plugin-builder) for instructions. -## Other plugin formats +## Copyright notices -Code for a LV2 plugin is also in this repository. But automated builds are excluded for LV2 because the rust lv2 crate doesn't have GUI support. The LV2 plugin format is being used for the MOD devices plugin which in turn does have a GUI. Because MOD has it's own GUI layer on top of the LV2 plugin. +DigiTech Whammy© is a trademark or trade name of another manufacturer and was used merely to identify the product whose sound was reviewed in the creation of this product. + +VST is a trademark of Steinberg Media Technologies GmbH, registered in Europe and other countries. + +All other trademarks are the property of their respective holders. + +VST trademark diff --git a/lv2/dm-Whammy.lv2/dm-Whammy.ttl b/lv2/dm-Whammy.lv2/dm-Whammy.ttl index a0ca0aa..55a652f 100644 --- a/lv2/dm-Whammy.lv2/dm-Whammy.ttl +++ b/lv2/dm-Whammy.lv2/dm-Whammy.ttl @@ -18,8 +18,10 @@ mod:brand "DM" ; mod:label "Whammy" ; rdfs:comment """ -A pitchshift effect written in Rust. -""" ; +A mono pitchshift effect inspired by the classic DigiTech Whammy© (*). + +(*) DigiTech Whammy© is a trademark or trade name of another manufacturer and was used merely to identify the product whose sound was reviewed in the creation of this product. All other trademarks are the property of their respective holders. +"""; lv2:requiredFeature lv2:inPlaceBroken ; lv2:optionalFeature lv2:hardRTCapable ; lv2:port [