Skip to content

Commit

Permalink
Adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thgrund committed Nov 10, 2024
1 parent d071394 commit 2bce547
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 28 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For the EQ of an orbit, this plugin is using EQui (https://github.com/thgrund/EQ
## Requirements

- [TidalCycles](https://github.com/tidalcycles/Tidal) v1.9.4+
- [SuperDirt Quark](https://github.com/musikinformatik/SuperDirt) v1.7.3+ (latest develop branch version)
- [SuperDirt Quark](https://github.com/musikinformatik/SuperDirt) v1.7.5+ (or latest develop branch version as lons as v1.7.5 is not released yet)

## Features

Expand Down Expand Up @@ -68,25 +68,23 @@ Pass this in your startup file after you installed it:
// More SuperDirt ...

// Initialize the SuperDirtMixer
~mixer = SuperDirtMixer(~dirt, 6010);
~mixer = SuperDirtMixer(~dirt);

// You can adjust parameters before you use the ui
~mixer.orbitLabels = ["d1 - Lead", "d2 - Bass", "d3 - Key", "d4 - Pad"];
~mixer.enableMasterPeakRMS(0)
~mixer.setOrbitLabels(["d1 - Lead", "d2 - Bass", "d3 - Key", "d4 - Pad"]);
~mixer.setMasterBus(0);

// When you added your settings in you startup file, then you should be able to use the ui at any time in any differtent SuperCollider file.
~mixer.gui;
}
)
```
And then you can render the gui with executing this in any SuperCollider file
```c
~mixer.gui
```

For more in depth configuration options you can have a look into the helpfile. This is accessable in SuperCollider when your cursor is on `SuperDirtMixer` and you press i.e. `Command + D` on MacOS.
## Preset management
You can load and overwrite existing preset files within the SuperDirtMixer ui. However to add new preset files, you need to create an empty json file within you preset folder. The default one is the preset folder within the SuperDirtMixer Quark.
You can load and overwrite existing preset files within the SuperDirtMixer ui. However to add new preset files, you need to create an empty json file within your preset folder. The default one is the preset folder within the SuperDirtMixer Quark.
The SuperDirtMixer is only shipped with one single `Default.json` file.
Expand Down
18 changes: 1 addition & 17 deletions classes/SuperDirtMixer.sc
Original file line number Diff line number Diff line change
@@ -1,27 +1,11 @@
/*
Optional TODOs
- [] Release everything when GUI is closed
StageMaster
- [x] Regler curve statt exp
StageMaster
- [] GR Anzeige des Compressor auf Summe
- [x] Limiter Level ist in dB
- [] peak dB Anzeige auf Master
Compressor
- [x] Regeler in zwei Gruppen (kreativ, und essenziell)
- [] HPF Label UI flakiness beheben
EQ
- [x] EQ Status (peak, filter etc.) Anzeige vergrößern
Preset Management
- [] Bessere und prominentere Dokumentation (für eigene Presets)
- [x] MrReason Presets löschen
*/
SuperDirtMixer {
var dirt;
Expand Down
2 changes: 1 addition & 1 deletion classes/uiComponents/CompressorUI.sc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ CompressorUI : UIFactories {

this.updateGlobalEffect(activeOrbit);

handler.emitEvent(\updateUI);
this.updateCompressorUI();
});

compressorElements = Dictionary.new;
Expand Down

0 comments on commit 2bce547

Please sign in to comment.