From 4adfbb2e17fc7d95c3efe9f9165bf77ef896aae1 Mon Sep 17 00:00:00 2001 From: jatin Date: Sat, 19 Nov 2022 14:32:40 -0800 Subject: [PATCH] Update changelog and user manual [ci skip] --- CHANGELOG.md | 7 ++++--- manual/Manual.md | 31 ++++++++++++++++--------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6c1cef8..7a2c70a9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to this project will be documented in this file. -## [UNRELEASED] +## [1.1.0] 2022-11-21 - Added support for the CLAP plugin format (with parameter modulation). - Added modulation ports so modules with internal modulation can share modulation signals. - Added "Rotary" module. @@ -13,12 +13,13 @@ All notable changes to this project will be documented in this file. - Added "Junior B" module. - Added "Bass Face" module. - Added "Blonde" modules. -- Added "Smooth Reverb" module. +- Added "Smooth Reverb" and "Shimmer Reverb" modules. - Added "Octaver" module. - Added "Neural" mode to Centaur module. - Added "Multi-Mode" option to SVF module. -- Added "High-Quality" options for RangeBooster and MuffDrive modules. +- Added "High-Quality" options for Range Booster and Muff Drive modules. - Added "Extend" and "Invert" options for Clean Gain module. +- Added support for Proteus models with a conditioning input for GuitarML module. - Added new factory presets. - Added UI control to replace a wire with a 1-input/1-output module. - Added UI control to replace a 1-input/1-output module with a wire. diff --git a/manual/Manual.md b/manual/Manual.md index fb8df864..fe0f1268 100644 --- a/manual/Manual.md +++ b/manual/Manual.md @@ -3,10 +3,10 @@ Build-Your-Own-Distortion (BYOD) is an audio plugin that allows the user to create custom guitar effects, with a focus on guitar distortion. The plugin contains emulations of guitar distortion -and tone-shaping circuits from various, along with a handful of -other useful effects. BYOD is currently available for Windows, -Linux, Mac, and iOS in the following formats: VST/VST3, AU, LV2, -AAX, AUv3, and Standalone. +and tone-shaping circuits from various pedals and amplifiers, +along with a handful of other useful effects. BYOD is currently +available for Windows, Linux, Mac, and iOS in the following formats: +VST/VST3, AU, CLAP, LV2, AAX, AUv3, and Standalone. Plugin GUI @@ -63,7 +63,7 @@ Purple modulation ports are available on all modulation processors. When connect Each processor has an on/off switch, as well as a settings menu, containing options to reset the processor's parameters, duplicate -the processor, or show the processor information. +the processor, replace the processor, or show the processor information. Processor Controls @@ -74,7 +74,7 @@ The bottom bar of the plugin (or top bar on iOS) contains several saving a preset. ### Undo/Redo -The undo/redo controls will undoor redo the following actions: +The undo/redo controls will undo or redo the following actions: - Adding/removing/replacing a processor - Creating/destroying a cables - Changing a parameter @@ -83,7 +83,7 @@ The undo/redo controls will undoor redo the following actions: Input mode: selects which channel(s) will be used as the input to the processor chain. In order to save computing resources (CPU), it is recommended to avoid using "Stereo" mode except when the -input is a stereo signal. +input is a true stereo signal. ### Input/Output Gain These controls can be used to affect the gain staging before or @@ -112,8 +112,10 @@ Modules". For the desktop plugin, add-on packs can be purchased from the [ChowDSP website](https://chowdsp.com/products/byod-add-ons/store.html); after purchase, an activation code will be sent via email, which can -then be used to activate the pack inside the plugin. For the iOS plugin, -add-on packs can be purchased in the plugin via an in-app purchase. +then be used to activate the pack inside the plugin. An activation code +may be used on up to 5 devices. For the iOS plugin, add-on packs can be +purchased in the plugin via an in-app purchase. Add-on packs for the iOS +plugin must be purchased separately due to the [App Store guidelines](https://developer.apple.com/app-store/review/guidelines). ## Presets @@ -148,12 +150,11 @@ To reset the global settings, you may delete this file, and it will automatically be regenerated the next time the plugin is used. ### OpenGL Rendering -On Windows and Linux, BYOD will use OpenGL for rendering the UI by -default, unless the host system does not support OpenGL version 2.0 -or greater. If OpenGL is available, it is possible to turn off rendering -with OpenGL in the [global settings menu](#settings). If you need -to override your chosen OpenGL setting, please visit the [global -settings file](#resetting-global-settings). +On Windows, BYOD will use OpenGL for rendering the UI by default, +unless the host system does not support OpenGL version 2.0 or greater. +If OpenGL is available, it is possible to turn off rendering with +OpenGL in the [global settings menu](#settings). If you need to +override your chosen OpenGL setting, please visit the [global settings file](#resetting-global-settings). ### Viewing Log Files Information about specific sessions of the plugin can be seen in