search

mruby-zest / mruby-zest-build

Root repo for mruby-zest containing links to all submodules
GNU Lesser General Public License v2.1
19 stars 23 forks source link

DynFilter is missing preset combo box #23

Open JohannesLorenz opened 4 years ago

JohannesLorenz commented 4 years ago

Note: This is a first-timers-only issue designed for individuals unfamiliar with contributing with open source contributions. If you're interested in working on the issue, then follow the details outlined below and communicate through this thread.

ZynAddSubFX has many effects. All effects have a set of presets, which allows users to quickly find good examples of how the effects can sound. One of the effects is the dynamic filter (often only called "DynFilter"). In the DynFilter UI, however, a combo box for the preset is missing. Instead, there are currently two (redundant) combo boxes for the filter category.

Setup:

  1. Clone github.com/zynaddsubfx/zynaddsubfx
  2. Clone github.com/mruby-zest/mruby-zest-build
  3. Compile zynaddsubfx configuring GuiModule in zynaddsubfx to be zest (via ccmake)
  4. Compile mruby-zest-build
  5. Run zynaddsubfx -U -P 1337 (does not try to launch it's own GUI, listens to port 1337)
  6. Run 'make run' within mruby-zest-build

Expected behavior:

Exactly one combo box for the filter category, and exactly one for the preset.

Actual behavior:

Two redundant combo boxes for the filter category, and none for the preset.

To fix:

The fix can be done in a submodule of the mruby-zest-build repo.

  1. Find out which qml file is affected (hint, search for one of the names of the knobs). It's not that difficult.
  2. Remove the duplicate "Pcategory" widget there.
  3. Find out how the category was added for another effect (e.g. Distorsion) and write analog code for the DynFilter.
  4. Find out which submodule you changed (git status in the main menu). Make a PR for that submodule.
fundamental commented 4 years ago

Sounds like something which can be turned into a first-timers-only style issue. Would you be interested in setting up that process?

JohannesLorenz commented 4 years ago

I'll try to make some hints for beginners (@fundamental feel free to correct):

  1. Find out which qml file is affected (hint, search for one of the names of the knobs). It's not that difficult.
  2. Remove the duplicate "Pcategory" widget there.
  3. Find out how the category was added for another effect (e.g. Distorsion) and write analog code for the DynFilter.
  4. Find out which submodule you changed (git status in the main menu). Make a PR for that submodule.
JohannesLorenz commented 4 years ago

@fundamental If that is sufficient for you, can you please turn the label to "good first issue"?

fundamental commented 4 years ago

Usually the idea of first-timers-only is for someone never exposed to the project before to have a step by step guide through the process. e.g. https://github.com/zynaddsubfx/zyn-fusion-issues/issues/222 There's various websites and bots which pick up on that tag. The detail provided puts this issue into the territory of a good-first-issue, but not to the level of verbosity of a first-timers-only one. The difference was brought up a few times at panels at the GSoC summit.

JohannesLorenz commented 4 years ago

Thanks for the info. I added a reminder to do this in the next week.

JohannesLorenz commented 4 years ago

@fundamental I updated the issue description in the top post. Can you please check it?

fundamental commented 4 years ago

Looks great to me. Thanks for taking the time to make the task more accessible :+1: