Skip to content
M G Berrotaran edited this page Jan 14, 2020 · 3 revisions

how to develop r_e_c_u_r

i have tried to write this application so it can easily be read and modified for different use cases. i recommend forking the repo to experiment with the codebase. open a pull request into origin <your_branch> if you want to contribute your changes back into the project.

this diagram might help understand the design :

design_overview

here are some examples of changes you might want to make:

rearranging the keypad controls

to simplify the key-mapping process, i have pre-mapped the numpad keys to the labels a to s like this:

premapped_keys

(see dotfiles for description of this process)

for each label the application will read the keypad_action_mapping.json file and map it to an action. the format also allows unique actions per control_mode and per the FUNCTION toggle :

...
"x": {
	"NAV_BROWSER": ["trigger_this_action_in_browser_mode"],
	"DEFAULT": ["trigger_this_action_in_any_other_mode_with_FN_off","trigger_this_action_in_any_other_mode_with_FN_on"],
}

creating a new action

updates in archetecture for v2 :

need to write this : -explain a bit about using openframeworks as backend , with this repo and this etc, how they communicate - osc etc ...

beyond

i hope the foundations iv provided encourage you to make larger changes for more ambitious features. if so you could try getting in touch (langolierz@gmail.com) first and maybe i could help align your approach with the rest of the project

just a reminder of some things i still need to do for documenting:

  • update dependances
  • update develop docs with info on new structure
  • update faq from questions in the fb group
Clone this wiki locally