Skip to content

Commit

Permalink
Continuing migration of documents to new directory 'doc'.
Browse files Browse the repository at this point in the history 
Updated the plugin manifest so that all Sapphire modules
link to the updated documentation URLs in the new 'doc'
directory.

Later this year, after I believe most people have upgraded,
I will delete the module documentation from the root directory.
  • Loading branch information
@cosinekitty
cosinekitty committed Feb 13, 2025
1 parent 18c7dff commit eb80061
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 68 deletions.
95 changes: 48 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ The latest release of the Sapphire plugin is available in the

## Video gallery

Videos of [VCV Rack patches using Sapphire modules](VideoGallery.md) by myself and others.
Videos of [VCV Rack patches using Sapphire modules](doc/VideoGallery.md) by myself and others.
No talking, just patching and listening.

[![Video gallery](https://img.youtube.com/vi/iNxV1i8zwNY/0.jpg)](VideoGallery.md)
[![Video gallery](https://img.youtube.com/vi/iNxV1i8zwNY/0.jpg)](doc/VideoGallery.md)

---

# Chaops

A left-expander module that provides additional functionality for the
chaos modules [Frolic](Frolic.md), [Glee](Glee.md), and [Lark](Lark.md).
chaos modules [Frolic](doc/Frolic.md), [Glee](doc/Glee.md), and [Lark](doc/Lark.md).

<a href="Chaops.md">Sapphire Chaops documentation</a>
<a href="doc/Chaops.md">Sapphire Chaops documentation</a>

<a href="Chaops.md"><img src="images/chaops.png" /></a>
<a href="doc/Chaops.md"><img src="doc/images/chaops.png" /></a>

---

Expand All @@ -30,29 +30,29 @@ chaos modules [Frolic](Frolic.md), [Glee](Glee.md), and [Lark](Lark.md).
A complex sound generator that simulates the physics of a
hexagonal mesh of balls and springs.

<a href="Elastika.md">Sapphire Elastika documentation</a>
<a href="doc/Elastika.md">Sapphire Elastika documentation</a>

<a href="Elastika.md"><img src="images/elastika.png" /></a>
<a href="doc/Elastika.md"><img src="doc/images/elastika.png" /></a>

---

## Env

A polyphonic envelope follower and pitch detector.

<a href="Env.md">Sapphire Env documentation</a>
<a href="doc/Env.md">Sapphire Env documentation</a>

<a href="Env.md"><img src="images/env.png" /></a>
<a href="doc/Env.md"><img src="doc/images/env.png" /></a>

---

## Frolic

A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.

<a href="Frolic.md">Sapphire Frolic documentation</a>
<a href="doc/Frolic.md">Sapphire Frolic documentation</a>

<a href="Frolic.md"><img src="images/frolic.png"/></a>
<a href="doc/Frolic.md"><img src="doc/images/frolic.png"/></a>

---

Expand All @@ -62,19 +62,19 @@ Galaxy is a stereo reverb filter, and is a clone of the
[Airwindows](https://library.vcvrack.com/Airwin2Rack/Airwin2Rack) Galactic algorithm
by [Chris Johnson](https://github.com/airwindows/airwindows).

<a href="Galaxy.md">Sapphire Galaxy documentation</a>
<a href="doc/Galaxy.md">Sapphire Galaxy documentation</a>

<a href="Galaxy.md"><img src="images/galaxy.png"/></a>
<a href="doc/Galaxy.md"><img src="doc/images/galaxy.png"/></a>

---

## Glee

A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.

<a href="Glee.md">Sapphire Glee documentation</a>
<a href="doc/Glee.md">Sapphire Glee documentation</a>

<a href="Glee.md"><img src="images/glee.png"/></a>
<a href="doc/Glee.md"><img src="doc/images/glee.png"/></a>

---

Expand All @@ -83,29 +83,29 @@ A chaotic oscillator for generating 3 simultaneous smooth but unpredictable volt
A stereo filter with CV-controllable frequency, resonance, mix, and gain.
Operates in lowpass, bandpass, or highpass mode.

<a href="Gravy.md">Sapphire Gravy documentation</a>
<a href="doc/Gravy.md">Sapphire Gravy documentation</a>

<a href="Gravy.md"><img src="images/gravy.png"/></a>
<a href="doc/Gravy.md"><img src="doc/images/gravy.png"/></a>

---

## Hiss

A random vector generator whose outputs point in all directions of an N-dimensional space with equal probability. Useful for generating vector noise input to physics simulations like Nucleus.

<a href="Hiss.md">Sapphire Hiss documentation</a>
<a href="doc/Hiss.md">Sapphire Hiss documentation</a>

<a href="Hiss.md"><img src="images/hiss.png"/></a>
<a href="doc/Hiss.md"><img src="doc/images/hiss.png"/></a>

---

## Lark

A chaotic oscillator for generating 3 simultaneous smooth but unpredictable voltages.

<a href="Lark.md">Sapphire Lark documentation</a>
<a href="doc/Lark.md">Sapphire Lark documentation</a>

<a href="Lark.md"><img src="images/lark.png"/></a>
<a href="doc/Lark.md"><img src="doc/images/lark.png"/></a>

---

Expand All @@ -114,9 +114,9 @@ A chaotic oscillator for generating 3 simultaneous smooth but unpredictable volt
Simulates plugging/unplugging cables,
which is sometimes different from setting their voltages to 0.

<a href="Moots.md">Sapphire Moots documentation</a>
<a href="doc/Moots.md">Sapphire Moots documentation</a>

<a href="Moots.md"><img src="images/moots.png" /></a>
<a href="doc/Moots.md"><img src="doc/images/moots.png" /></a>

---

Expand All @@ -125,33 +125,34 @@ which is sometimes different from setting their voltages to 0.
A simulation of five particles obeying alternative laws of physics.
The output can be used for control voltages or audio signals.

<a href="Nucleus.md">Sapphire Nucleus documentation</a>
<a href="doc/Nucleus.md">Sapphire Nucleus documentation</a>

<a href="Nucleus.md"><img src="images/nucleus.png" /></a>
<a href="doc/Nucleus.md"><img src="doc/images/nucleus.png" /></a>

---

## Sauce

A polyphonic filter with CV-controllable frequency, resonance, mix, and gain.
Provides simultaneous lowpass, bandpass, and highpass outputs.
This is the polyphonic version of the [Gravy](Gravy.md) stereo filter.
This is the polyphonic version of the [Gravy](doc/Gravy.md) stereo filter.

<a href="Sauce.md">Sapphire Sauce documentation</a>
<a href="doc/Sauce.md">Sapphire Sauce documentation</a>

<a href="Sauce.md"><img src="images/sauce.png"/></a>
<a href="doc/Sauce.md"><img src="doc/images/sauce.png"/></a>

---

## Pivot

Twists an input 3D vector by a CV-adjustable angle.
Pivot is useful in combination with [Frolic](Frolic.md), [Glee](Glee.md), and [Rotini](Rotini.md)
Pivot is useful in combination with [Frolic](doc/Frolic.md),
[Glee](doc/Glee.md), and [Rotini](doc/Rotini.md)
to create novel chaotic control signals for modulating generative movement in your patches.

<a href="Pivot.md">Sapphire Pivot documentation</a>
<a href="doc/Pivot.md">Sapphire Pivot documentation</a>

<a href="Pivot.md"><img src="images/pivot.png" /></a>
<a href="doc/Pivot.md"><img src="doc/images/pivot.png" /></a>

---

Expand All @@ -160,9 +161,9 @@ to create novel chaotic control signals for modulating generative movement in yo
Just like Nucleus, only with a single polyphonic port
for each particle instead of 3 monophonic ports.

<a href="Polynucleus.md">Sapphire Polynucleus documentation</a>
<a href="doc/Polynucleus.md">Sapphire Polynucleus documentation</a>

<a href="Polynucleus.md"><img src="images/polynucleus.png" /></a>
<a href="doc/Polynucleus.md"><img src="doc/images/polynucleus.png" /></a>

---

Expand All @@ -172,9 +173,9 @@ A polyphonic trigger generator that can simulate the statistical
behavior of radioactive decay, generate completely regular pulses,
or anywhere in between.

<a href="Pop.md">Sapphire Pop documentation</a>
<a href="doc/Pop.md">Sapphire Pop documentation</a>

<a href="Pop.md"><img src="images/pop.png" /></a>
<a href="doc/Pop.md"><img src="doc/images/pop.png" /></a>

---

Expand All @@ -183,9 +184,9 @@ or anywhere in between.
A utility module for combining Frolic/Glee into more complex chaotic 3D vector signals.
Calculates the cross product of two input vectors.

<a href="Rotini.md">Sapphire Rotini documentation</a>
<a href="doc/Rotini.md">Sapphire Rotini documentation</a>

<a href="Rotini.md"><img src="images/rotini.png" /></a>
<a href="doc/Rotini.md"><img src="doc/images/rotini.png" /></a>

---

Expand All @@ -195,47 +196,47 @@ Splits, adds, and/or merges a stereo or 3D polyphonic signal with 2 or 3 monopho
This is like VCV Merge and VCV Split combined, but only for a maximum of 3 channels.
SplitAddMerge saves patch screen space because it is only 2 HP wide.

<a href="SplitAddMerge.md">Split/Add/Merge documentation</a>
<a href="doc/SplitAddMerge.md">Split/Add/Merge documentation</a>

<a href="SplitAddMerge.md"><img src="images/splitAddMerge.png" /></a>
<a href="doc/SplitAddMerge.md"><img src="doc/images/splitAddMerge.png" /></a>

---

## Tin

An alterative input module for feeding data into Tricorder.

<a href="Tin.md">Sapphire Tin documentation</a>
<a href="doc/Tin.md">Sapphire Tin documentation</a>

<a href="Tin.md"><img src="images/tin.png" /></a>
<a href="doc/Tin.md"><img src="doc/images/tin.png" /></a>

---

## Tout

A utility for extracting vector data from Tricorder as output ports.

<a href="Tout.md">Sapphire Tout documentation</a>
<a href="doc/Tout.md">Sapphire Tout documentation</a>

<a href="Tout.md"><img src="images/tout.png" /></a>
<a href="doc/Tout.md"><img src="doc/images/tout.png" /></a>

---

## Tricorder

A 3D oscilloscope designed for Frolic, Glee, and other 3D signals.

<a href="Tricorder.md">Sapphire Tricorder documentation</a>
<a href="doc/Tricorder.md">Sapphire Tricorder documentation</a>

<a href="Tricorder.md"><img src="images/tricorder.png" /></a>
<a href="doc/Tricorder.md"><img src="doc/images/tricorder.png" /></a>

---

## Tube Unit

A complex tubular waveguide synthesizer.

<a href="TubeUnit.md">Sapphire Tube Unit documentation</a>
<a href="doc/TubeUnit.md">Sapphire Tube Unit documentation</a>

<a href="TubeUnit.md"><img src="images/tubeunit.png" /></a>
<a href="doc/TubeUnit.md"><img src="doc/images/tubeunit.png" /></a>

Loading

0 comments on commit eb80061

Please sign in to comment.