Update readme v0.6.3

j4s0n-c · Jun 25, 2018 · 9c6d2eb · 9c6d2eb
1 parent c292a49
commit 9c6d2eb
Showing 1 changed file with 53 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -4,28 +4,32 @@
 </div>
 
 trowaSoft Modules plugin for [VCV Rack](https://github.com/VCVRack/Rack) v0.5.x and v0.6.x. 
-Current pack includes [trigSeq &amp; trigSeq64](#trigseq--trigseq64), [voltSeq](#voltseq), [multiScope](#multiscope), and [cvOSCcv](#cvosccv) (**new 2018-03-20**).
+Current pack includes [trigSeq &amp; trigSeq64](#trigseq--trigseq64), [voltSeq](#voltseq), [multiWave](#multiwave) (new 2018-06-24), [multiScope](#multiscope), and [cvOSCcv](#cvosccv).
 
 For more information about these modules, please visit:
 http://www.geekasaurusrex.net/page/trowaSoft-Sequencer-Modules-for-VCV-Rack.aspx.
 
 For more information about Rack, please visit:
 https://vcvrack.com/.
 
-If you like the modules and wish to donate, you may do so [here](https://paypal.me/j4s0n). Any donation is much appreciated.
+If you like the modules and wish to donate, you may do so [here](https://paypal.me/j4s0n). Any donation is much appreciated! Also note though that:
++ $5 USD buys the 'dev team' a Jack &amp; Diet (programming fuel) at a neighborhood bar.
++ $10 USD buys the designer a bottle of wine.
 
 ## Binaries/Builds
 Any builds that are currently available are at [Github Releases page](https://github.com/j4s0n-c/trowaSoft-VCV/releases) and [geeksaurusrex](http://www.geekasaurusrex.net/page/trowaSoft-Sequencer-Modules-for-VCV-Rack.aspx). 
+Recent builds should also be available in the [VCV plugin manager](https://vcvrack.com/plugins.html).
 
 **VCV Rack v0.6.x**:
-**2018-06-17**: The latest version is [v0.6.2](https://github.com/j4s0n-c/trowaSoft-VCV/releases/tag/v0.6.2) (for Rack v0.6.1).
+**2018-06-24**: The latest version is [v0.6.3](https://github.com/j4s0n-c/trowaSoft-VCV/releases/tag/v0.6.3) (for Rack v0.6.1).
 
 **VCV Rack v0.5.x**:
 2018-02-17: The last version is [v0.5.5.2](https://github.com/j4s0n-c/trowaSoft-VCV/releases/tag/v0.5.5.2). No more versions for Rack 0.5.x will be developed.
 
 
 To build for your platform, please visit the [VCV rack documentation](https://github.com/VCVRack/Rack#setting-up-your-development-environment).
 
+
 ## Sequencers
 Currently there are three (3) sequencer modules.
 
@@ -34,9 +38,9 @@ Currently there are three (3) sequencer modules.
 <img width="390" src="http://www.geekasaurusrex.net/image.axd?picture=2017%2f12%2ftrigSeq_screenshot.jpg" />
 <img width="390" src="http://www.geekasaurusrex.net/image.axd?picture=2017%2f12%2ftrigSeq64_screenshot.jpg" />
 </div>
-
-
+
 These are basic boolean on/off pad step sequencers (0V or 10V), based off the [Fundamentals SEQ3 sequencer](https://github.com/VCVRack/Fundamental).
+
 + **trigSeq** is 16-step; **trigSeq64** is 64-step.
 + Now 64 patterns. ~~16 patterns.~~
 + 16 channels (outputs).
@@ -51,9 +55,9 @@ These are basic boolean on/off pad step sequencers (0V or 10V), based off the [F
 <div>
 <img width="390" src="http://www.geekasaurusrex.net/image.axd?picture=2017%2f12%2fvoltSeq_screenshot.jpg" />
 </div>
+
+**voltSeq** is a variable voltage output step sequencer (-10V to +10V), based off the [Fundamentals SEQ3 sequencer](https://github.com/VCVRack/Fundamental).
 
-
-Variable voltage output step sequencer (-10V to +10V), based off the [Fundamentals SEQ3 sequencer](https://github.com/VCVRack/Fundamental).
 + **voltSeq** is 16-step.
 + Now 64 patterns. ~~16 patterns.~~
 + 16 channels (outputs).
@@ -67,6 +71,43 @@ Variable voltage output step sequencer (-10V to +10V), based off the [Fundamenta
 + Advanced Randomization options (as of v.0.5.5.2) for all patterns, current edit pattern, or only the displayed channel. Chose from 'normal random' or 'structured' random patterns.
 + Shift Values (as of v0.5.5.2): +/- 1 Volt or 1 Octave or 1 Pattern for all patterns, current edit pattern, or only the displayed channel.
 
+## multiWave
+<div>
+<img width="700" src="https://github.com/j4s0n-c/trowaSoft-VCV/blob/master/screenshots/multiWave_screenshot.png?raw=true" />
+</div>
+
+**multiWave** is a digital oscillator module with three (3) oscillators/clocks, each with two (2) configurable wave channel outputs. This module has been made to complement <a href="#multiscope">multiScope</a>
+and is new in v0.6.3.
+
++ Screen User Controls:
+    + Click on a value to edit it directly (a text box should appear and allow you to type the value).
+    + **Tab** or **Tab-Shift** will iterate through the editable text boxes. 
+    + Valid for all displayed values except for WAVE and AUX (AUX is only an editable textbox for pulse width when SQR/rectangle wave is selected).
+
++ CV Inputs & User Controls per Oscillator:
+    + **SYNC** - (Right hand side) Reset/sync the oscillator (to phase 0). Currently this is CV only (no UI control).
+    + **AMPL** - Amplitude (-10V to +10V).
+    + **FREQ** - Frequency (1V/Oct) for the oscillator clock.  
+    The Frequency knob rotates 360&deg;. Hold down the **Shift** key for coarser control or the **Control** key for finer control while dragging up/down.
+    + **PHASE** - Phase Shift (-10V to +10V).
+    + **OFFSET** - Offset (-10V to +10V).
+    + CV Inputs & User Controls per Channel Output:
+        + **WAV** - Waveform Type (-5V to +5V): SIN, TRI, SAW, SQR.
+        + **AUX** - Aux (-5V to +5V). If the CV input is active then, the knob value is ignored.  
+        Currently only SAW and SQR have functions: 
+		    + SAW: Slope (pos |/| or neg |\\|). 0 or positive CV for positive slope.
+			+ SQR: Pulse Width.
+			+ SIN and TRI adjustments will be added later when/if we think of another parameter for these waveforms.  
+        + **PHASE** - Phase Shift (-10V to +10V). Value is relative to the oscillator clock.
+        + **MOD** - Amplitude modulation (-10V to +10V). Knob controls the mix between the raw signal and the modded signal.
+        + **\*** - Button for modulation type (Digital or Ring). Currently this is UI only (no CV input).
+
++ CV Outputs per Oscillator:
+    + **SYNC** - Triggers whenever the period restarts.
+    + CV Outputs per Channel Output:
+        + **X&lt;n&gt; or Y&lt;n&gt;** - RAW waveform without amplitude modulation (**MOD**).
+        + **MOD** - The modulated waveform (based on the MOD knob and the incoming MOD signal input).
+
 ## multiScope
 <div>
 <img width="700" src="https://github.com/j4s0n-c/trowaSoft-VCV/blob/master/screenshots/multiScope_screenshot_02.png?raw=true" />
@@ -102,7 +143,7 @@ Variable voltage output step sequencer (-10V to +10V), based off the [Fundamenta
         + **R** - Rotation knob. If an input is active on the Rotation port, this is ignored.
         + **ABS** - (Toggle) Turning ABS on will make the rotation inputs control the absolute angular position instead of a rate.		
     + **T** - Time adjustment knob. Will be used along with the Time input port.
-    + **TH** - Line Thickness. If an input is active on the Thickenss port, this is ignored.
+    + **TH** - Line Thickness. If an input is active on the Thickness port, this is ignored.
 	+ **EFFECT** - Effect knob.
     + **X*Y** - (Toggle) Toggle lissajous mode on / off (default is on).
 
@@ -115,8 +156,9 @@ Variable voltage output step sequencer (-10V to +10V), based off the [Fundamenta
 <div>
 <img width="700" src="https://github.com/j4s0n-c/trowaSoft-VCV/blob/master/screenshots/cvOSCcv_screenshot_01.png?raw=true" />
 </div>
-
+  
 **cvOSCcv** is a simple, generic Open Sound Control (OSC) module for outputting Rack CVs to OSC and reading in simple OSC messages into Rack CVs. This module is new in version 0.6.0.
+
 + **CV Inputs** - CV => OSC (8 Channels), each channel:
     + **TRG** - If active, then OSC messages will output the **VAL** CV input when triggered.
     + **VAL** - The value that will output over OSC. Currently sent as a float.
@@ -130,9 +172,10 @@ Variable voltage output step sequencer (-10V to +10V), based off the [Fundamenta
 	+ **Out Port** - Port for sending messages. 
 	+ **In Port** - Port for receiving messages. Currently, trowaSoft modules can NOT share the same ports.
 	+ **Namespace** - The OSC namespace. Default is `trowacv`.
+	+ **Auto Con** - Automatically reconnect on load from save. The connection will be restore if the connection was active (in the save file) and this is checked.
     + Per Channel:  
         + **Address** - Endpoint address. Default is `/ch/{channel #}`.
-		+ **ADV** - (v0.6.2) Advanced settings for simple value conversions. Specify simple OSC data types (float, int, bool) and the CV and OSC ranges.
+		+ **ADV** - (as of v0.6.2) Advanced settings for simple value conversions. Specify simple OSC data types (float, int, bool) and the CV and OSC ranges.
 
 	NOTE: To save Channel Address changes after a connection is active, simply hide the configuration screen again.