feat!: Rename the project from MKPlugins to PortedPlugins

madskjeldgaard · Sep 11, 2021 · 48046cf · 48046cf
1 parent d87b764
commit 48046cf
Show file tree

Hide file tree

Showing 28 changed files with 50 additions and 50 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -7,7 +7,7 @@
 ####################################################################################################
 # basic project config
 cmake_minimum_required(VERSION 3.8)
-set(project_name "MKPlugins")
+set(project_name "PortedPlugins")
 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake_modules ${CMAKE_MODULE_PATH})
 
 # Eigen seems to prefer 17

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,7 +21,7 @@ A contribution can be many things: Opening an issue or a feature request (or a p
 
 ## Submit an idea for a plugin
 
-Feel free to post ideas for things to port over [on the discussions forum.](https://github.com/madskjeldgaard/mkplugins/discussions/23)
+Feel free to post ideas for things to port over [on the discussions forum.](https://github.com/madskjeldgaard/portedplugins/discussions/23)
 
 ## Commit message style
 
@@ -50,7 +50,7 @@ It's really simple to use. From the root of the repo folder, run:
 
 This will create a folder in `plugins` called `SuperPlugin` containing C++ files, an SC file and a help file. The script will also add the plugin to [CMakeLists.txt](CMakeLists.txt) so the compiler will pick it up properly. 
 
-The only thing you need to manually do is to open the overview help file [plugins/HelpSource/Overview/MKPlugins.schelp](plugins/HelpSource/Overview/MKPlugins.schelp) and add it to the list (TODO: this should be automated).
+The only thing you need to manually do is to open the overview help file [plugins/HelpSource/Overview/PortedPlugins.schelp](plugins/HelpSource/Overview/PortedPlugins.schelp) and add it to the list (TODO: this should be automated).
 
 ### Including extra header/implementation files
 Note: If your plugin uses extra header files/C++ files, you need to add these to the CMakelists entry for your plugin. As an example, here is the LockhartWavefolder plugin's cpp files entry. `LockhartCell.cpp` and `LockhartCell.hpp` are used in the main plugin files `LockhartWavefolder.cpp` and `LockhartWavefolder.hpp`: 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-[![.github/workflows/cmake.yml](https://github.com/madskjeldgaard/mkplugins/actions/workflows/cmake.yml/badge.svg)](https://github.com/madskjeldgaard/mkplugins/actions/workflows/cmake.yml)
+[![.github/workflows/cmake.yml](https://github.com/madskjeldgaard/portedplugins/actions/workflows/cmake.yml/badge.svg)](https://github.com/madskjeldgaard/portedplugins/actions/workflows/cmake.yml)
 
-# MKPlugins
+# PortedPlugins
 
 A collection of plugins for the [SuperCollider sound environment](https://supercollider.github.io/), all of which are ported / remixed from elsewhere - including hardware synthesizers, research papers / demos, VST plugins, VCV rack and other programming environments.
 
@@ -22,7 +22,7 @@ A collection of plugins for the [SuperCollider sound environment](https://superc
 
 ## Included plugins
 
-See the `MKPlugins.schelp` help file for an overview inside of SuperCollider and the respective help files for each plugin for more information about the particularities of each plugin.
+See the `PortedPlugins.schelp` help file for an overview inside of SuperCollider and the respective help files for each plugin for more information about the particularities of each plugin.
 
 - **AnalogBassDrum** - Virtual analog 808 bass drum model. Original code by [Èmilie Gillet / Mutable Instruments](https://github.com/pichenettes/eurorack). Revisited by Ben Sergentanis for the [DaisySP DSP library](https://github.com/electro-smith/DaisySP). 
 - **AnalogPhaserMod** - The modulation section of a phaser based on/inspired by classic krautrock phasers. Ported from [Jatin Chowdhury's ChowDSP-VCV-rack project](https://github.com/jatinchowdhury18/ChowDSP-VCV).
@@ -44,7 +44,7 @@ See the `MKPlugins.schelp` help file for an overview inside of SuperCollider and
 - **PhasorModal** - Ported from [Jatin Chowdhury's ChowDSP-VCV-rack project](https://github.com/jatinchowdhury18/ChowDSP-VCV).
 - **Resonator** - A resonant body simulation (originally found in the Mutable Instruments Rings synthesizer module). Original code by [Èmilie Gillet / Mutable Instruments](https://github.com/pichenettes/eurorack). Revisited by Ben Sergentanis for the [DaisySP DSP library](https://github.com/electro-smith/DaisySP). 
 - **Rongs** - A modal synthesis voice. This is a remix of the Mutable Instruments Rings algorithm allowing unrealistic sounds of sloppy gongs and 100km long strings. Original code by [Èmilie Gillet / Mutable Instruments](https://github.com/pichenettes/eurorack).
-See the overview helpfile [MKPlugins](/plugins/HelpSource/Overview/MKPlugins.schelp) for more information which plugins are included.
+See the overview helpfile [PortedPlugins](/plugins/HelpSource/Overview/PortedPlugins.schelp) for more information which plugins are included.
 - **StringVoice** - Extended Karplus-Strong. Original code by [Èmilie Gillet / Mutable Instruments](https://github.com/pichenettes/eurorack). Revisited by Ben Sergentanis for the [DaisySP DSP library](https://github.com/electro-smith/DaisySP). 
 - **VadimFilter** - Virtual analog low pass, high pass and band pass filters based on the [ground breaking work of Vadim Zavalishin](https://www.native-instruments.com/fileadmin/ni_media/downloads/pdf/VAFilterDesign_1.1.1.pdf). Ported from  [folderkit](https://codeberg.org/nonmateria/folderkit) 
 - **VarShapeOsc** - Variable Waveshape Oscillator. Original code by [Èmilie Gillet / Mutable Instruments](https://github.com/pichenettes/eurorack). Revisited by Ben Sergentanis for the [DaisySP DSP library](https://github.com/electro-smith/DaisySP). 
@@ -59,13 +59,13 @@ See the overview helpfile [MKPlugins](/plugins/HelpSource/Overview/MKPlugins.sch
 ## Installation
 
 **Instructions for most systems**:
-1. Download one of [the prebuilt releases](https://github.com/madskjeldgaard/mkplugins/releases). Choose the one that fits your operating system.
+1. Download one of [the prebuilt releases](https://github.com/madskjeldgaard/portedplugins/releases). Choose the one that fits your operating system.
 2. Unzip the contents in your extensions directory (If you don't know where this is, open up SuperCollider and evaluate `Platform.userExtensionDir` - the path will be posted in the post window).
 3. Recompile class library.
 
 **Arch Linux**:
 
-`yay -S supercollider-mkplugins`
+`yay -S supercollider-portedplugins`
 
 **RaspberryPi OS**:
 
@@ -82,11 +82,11 @@ See the accompanying script for downloading, building and installing the plugins
 #### Preparations for a build
 Clone the project:
 
-	git clone https://github.com/madskjeldgaard/mkplugins
-	cd mkplugins
+	git clone https://github.com/madskjeldgaard/portedplugins
+	cd portedplugins
 	git submodule update --init --recursive
 
-This will get you the mkplugins.
+This will get you the portedplugins.
 
 Before continuing, you need two things: 
 

diff --git a/plugins/AnalogBassDrum/AnalogBassDrum.schelp b/plugins/AnalogBassDrum/AnalogBassDrum.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogBassDrum
 SUMMARY:: Virtual analog 808 bass drum model 
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>VirtualAnalog, UGens>Drums
 
 DESCRIPTION::

diff --git a/plugins/AnalogSnareDrum/AnalogSnareDrum.schelp b/plugins/AnalogSnareDrum/AnalogSnareDrum.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogSnareDrum
 SUMMARY:: Virtual analog 808 snare drum model.
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>VirtualAnalog, UGens>Drums
 
 DESCRIPTION::

diff --git a/plugins/BLOsc/BLOsc.schelp b/plugins/BLOsc/BLOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: BLOsc
 SUMMARY:: Band limited oscillator
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/Chen/Chen.schelp b/plugins/Chen/Chen.schelp
@@ -1,6 +1,6 @@
 class:: Chen
 summary:: Chen's chaotic double scroll attractor
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 categories:: UGens>Generators>Chaotic
 
 description::

diff --git a/plugins/ChowDSP/AnalogPhaser.schelp b/plugins/ChowDSP/AnalogPhaser.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogPhaser
 SUMMARY:: A virtual-analog feedback phaser
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>VirtualAnalog
 
 DESCRIPTION::

diff --git a/plugins/ChowDSP/AnalogPhaserMod.schelp b/plugins/ChowDSP/AnalogPhaserMod.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogPhaserMod
 SUMMARY:: Virtual Analog allpass phaser modulation section
-RELATED::HelpSource/Overview/MKPlugins, Classes/AnalogPhaser
+RELATED::HelpSource/Overview/PortedPlugins, Classes/AnalogPhaser
 CATEGORIES::UGens>VirtualAnalog
 
 DESCRIPTION::

diff --git a/plugins/ChowDSP/AnalogTape.schelp b/plugins/ChowDSP/AnalogTape.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogTape
 SUMMARY:: Analog tape emulation
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>VirtualAnalog
 
 DESCRIPTION::

diff --git a/plugins/ChowDSP/AnalogVintageDistortion.schelp b/plugins/ChowDSP/AnalogVintageDistortion.schelp
@@ -1,6 +1,6 @@
 CLASS:: AnalogVintageDistortion
 SUMMARY::A virtual analog vintage EQ and distortion
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>VirtualAnalog
 
 DESCRIPTION::

diff --git a/plugins/DCompressor/DCompressor.schelp b/plugins/DCompressor/DCompressor.schelp
@@ -1,6 +1,6 @@
 CLASS:: DCompressor
 SUMMARY:: Simple compressor
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Dynamics
 
 DESCRIPTION::

diff --git a/plugins/HarmonicOsc/HarmonicOsc.schelp b/plugins/HarmonicOsc/HarmonicOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: HarmonicOsc
 SUMMARY:: 16 voice harmonic oscillator
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/HelpSource/Overview/MKPlugins.schelp → .../HelpSource/Overview/PortedPlugins.schelp b/plugins/HelpSource/Overview/MKPlugins.schelp → .../HelpSource/Overview/PortedPlugins.schelp
@@ -1,18 +1,13 @@
-title:: MKPlugins
-summary:: An overview of the MKPlugins UGens
+title:: PortedPlugins
+summary:: An overview of the PortedPlugins UGens
 categories:: Synthesis
 related:: Classes/LPG
 
-LINK::https://github.com/madskjeldgaard/mkplugins/##MKPlugins:: is a collection of UGens written by Mads Kjeldgaard.
+LINK::https://github.com/madskjeldgaard/portedplugins/##PortedPlugins:: is a collection of UGens, all of which are ported / remixed from elsewhere - including hardware synthesizers, research papers / demos, VST plugins, VCV rack and other programming environments.
 
 The collection contains the following UGens:
 
 LIST::
-## LINK::Classes/VADiodeFilter::
-## LINK::Classes/VAKorg35::
-## LINK::Classes/VALadder::
-## LINK::Classes/VASEM12::
-## LINK::Classes/VA1Pole::
 ## LINK::Classes/AnalogBassDrum::
 ## LINK::Classes/AnalogFoldOsc::
 ## LINK::Classes/AnalogPhaser::
@@ -26,16 +21,21 @@ LIST::
 ## LINK::Classes/HarmonicOsc::
 ## LINK::Classes/LPG::
 ## LINK::Classes/LockhartWavefolder::
-## LINK::Classes/NonlinearFilter::
 ## LINK::Classes/NeoFormant::
 ## LINK::Classes/NeoVarSawOsc::
+## LINK::Classes/NonlinearFilter::
 ## LINK::Classes/OscBank::
 ## LINK::Classes/PhasorModal::
 ## LINK::Classes/Resonator::
 ## LINK::Classes/Rongs::
 ## LINK::Classes/StringVoice::
-## LINK::Classes/VarShapeOsc::
+## LINK::Classes/VA1Pole::
+## LINK::Classes/VADiodeFilter::
+## LINK::Classes/VAKorg35::
+## LINK::Classes/VALadder::
+## LINK::Classes/VASEM12::
 ## LINK::Classes/VadimFilter::
+## LINK::Classes/VarShapeOsc::
 ## LINK::Classes/VosimOsc::
 ## LINK::Classes/ZOsc::
 ::
diff --git a/plugins/LPG/LPG.schelp b/plugins/LPG/LPG.schelp
@@ -1,6 +1,6 @@
 CLASS::LPG
 SUMMARY::A digital model of the Buchla Lowpass-Gate
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Filters
 
 DESCRIPTION::

diff --git a/plugins/NeoFormant/NeoFormant.schelp b/plugins/NeoFormant/NeoFormant.schelp
@@ -1,6 +1,6 @@
 CLASS:: NeoFormant
 SUMMARY::Formant oscillator with aliasing-free phase reset
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/NeoVarSawOsc/NeoVarSawOsc.schelp b/plugins/NeoVarSawOsc/NeoVarSawOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: NeoVarSawOsc
 SUMMARY:: Variable saw oscillator
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/NonlinearFilter/NonlinearFilter.schelp b/plugins/NonlinearFilter/NonlinearFilter.schelp
@@ -1,6 +1,6 @@
 CLASS:: NonlinearFilter
 SUMMARY::Flexible filter with saturation in the feedback loop
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Filters
 
 DESCRIPTION::

diff --git a/plugins/OscBank/OscBank.schelp b/plugins/OscBank/OscBank.schelp
@@ -1,6 +1,6 @@
 CLASS:: OscBank
 SUMMARY:: An oscillator bank in the style of divide-down organs
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/Resonator/Resonator.schelp b/plugins/Resonator/Resonator.schelp
@@ -1,6 +1,6 @@
 CLASS:: Resonator
 SUMMARY:: A resonant body simulation.
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>PhysicalModelling
 
 DESCRIPTION::

diff --git a/plugins/Rongs/Rongs.schelp b/plugins/Rongs/Rongs.schelp
@@ -1,6 +1,6 @@
 CLASS:: Rongs
 SUMMARY:: A modal synthesis voice
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>PhysicalModelling
 
 DESCRIPTION::

diff --git a/plugins/StringVoice/StringVoice.schelp b/plugins/StringVoice/StringVoice.schelp
@@ -1,6 +1,6 @@
 CLASS:: StringVoice
 SUMMARY:: Extended Karplus-Strong
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>PhysicalModelling
 
 DESCRIPTION::

diff --git a/plugins/VarShapeOsc/VarShapeOsc.schelp b/plugins/VarShapeOsc/VarShapeOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: VarShapeOsc
 SUMMARY:: Variable Waveshape Oscillator
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/VosimOsc/VosimOsc.schelp b/plugins/VosimOsc/VosimOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: VosimOsc
 SUMMARY:: Vosim oscillator
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/plugins/ZOsc/ZOsc.schelp b/plugins/ZOsc/ZOsc.schelp
@@ -1,6 +1,6 @@
 CLASS:: ZOsc
 SUMMARY:: Sinewave multiplied by and sync'ed to a carrier
-RELATED::HelpSource/Overview/MKPlugins
+RELATED::HelpSource/Overview/PortedPlugins
 CATEGORIES::UGens>Oscillator
 
 DESCRIPTION::

diff --git a/scripts/PKGBUILD b/scripts/PKGBUILD
@@ -1,10 +1,10 @@
 # Maintainer: Mads Kjeldgaard <[email protected]>
-pkgname=supercollider-mkplugins
+pkgname=supercollider-portedplugins
 pkgver=r26.fe11076
 pkgrel=1
 pkgdesc="Mads Kjeldgaard's SuperCollider plugins"
 arch=('x86_64')
-url="https://www.github.com/madskjeldgaard/mkplugins"
+url="https://www.github.com/madskjeldgaard/portedplugins"
 license=('GPL')
 groups=('pro-audio')
 depends=('supercollider')

diff --git a/scripts/add_plugin b/scripts/add_plugin
@@ -251,7 +251,7 @@ function regen_help_globals(){
 
 function append_to_overview(){
 	echo "Appending to overview help file"
-	OVERVIEWFILE=plugins/HelpSource/Overview/MKPlugins.schelp
+	OVERVIEWFILE=plugins/HelpSource/Overview/PortedPlugins.schelp
 	PASTE_AFTER_LINE=$(awk '/LIST::/ {print FNR}' $OVERVIEWFILE)+1
 
 	sed -i "${PASTE_AFTER_LINE} i ## LINK::Classes/${PLUGIN_NAME}::" $OVERVIEWFILE

diff --git a/scripts/rpi_build b/scripts/rpi_build
@@ -5,8 +5,8 @@ sudo apt install cmake
 
 mkdir tmp
 
-# mkplugins
-git clone --recurse-submodules https://github.com/madskjeldgaard/mkplugins.git tmp/mkplugins
+# portedplugins
+git clone --recurse-submodules https://github.com/madskjeldgaard/portedplugins.git tmp/portedplugins
 
 # Get sc source code
 git clone --recurse-submodules https://github.com/supercollider/supercollider.git tmp/supercollider
@@ -15,7 +15,7 @@ git clone --recurse-submodules https://github.com/supercollider/supercollider.gi
 INSTALL_DIR=$HOME/local/share/SuperCollider/Extensions
 SC_DIR=$HOME/tmp/supercollider
 
-cd tmp/mkplugins
+cd tmp/portedplugins
 echo "Making build directory... "
 mkdir build
 cd build
@@ -27,5 +27,5 @@ cmake --build . --config Release --target install
 
 # Clean up
 cd $HOME
-rm -rf $HOME/tmp/mkplugins
+rm -rf $HOME/tmp/portedplugins
 rm -rf $HOME/tmp/supercollider