eessppeelllloo/r_e_c_u_r
1
0
Fork 0
mirror of https://github.com/cyberboy666/r_e_c_u_r.git synced 2025-12-13 03:40:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

working on documentation

Browse Source
This commit is contained in:
Tim Caldwell
2018-02-08 22:52:08 +13:00
parent 7061bdf818
commit 53b8146f93
16 changed files with 37 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
documentation/operate_docs.md
View File

@@ -10,14 +10,14 @@
## controls
the controls on r_e_c_u_r work by mapping `keys` to `actions`. (custom mappings ?) by default most keys map to the same action independant of the state (ie display mode) the r_e_c_u_r is in.
the controls on r_e_c_u_r work by mapping `keys` to `actions`. (custom mappings ?) by default most keys map to the same action independent of the state (ie display mode) the r_e_c_u_r is in.
The exceptions to this are the control keys:
- `<` and `>` : used for navigation when applicable (see below) ; used for seeking current sample in `SAMPLER` mode
- `■` : used as 'enter' for navigation ; used to toggle pause/play in `SAMPLER` mode.
the display modes described below are cycled by using the `DISPLAY` key. some actions are accessable through a `2ND FUNC` layer, toggled by the corrosponding key.
the display modes described below are cycled by using the `DISPLAY` key. some actions are accessible through a `2ND FUNC` layer, toggled by the corresponding key.
other controls include:
- `→` is used to trigger the next loaded sample to play
@@ -28,9 +28,13 @@ other controls include:
some keys are empty to leave room for future features. i encourage you to make a custom key map (link to doc) or add actions (another link) you would like to use.
## parts of the lcd display
![display_image][display_image]
## `PLAYER` display
this section displays infomation about what is in the video player : the position from start and end of currently playing video, what [slot] is playing now and what slot is loaded [next]
this section displays information about what is in the video player : the position from start and end of currently playing video, what [slot] is playing now and what slot is loaded [next]
## `BROWSER` display mode
@@ -39,11 +43,11 @@ this is where you can load samples from your usb into the `SAMPLER`
- in this mode , the `<` and `>` keys will move the selection up and down
- folders are displayed ending in `|` for closed and `/` for open , the depth is displayed as indentation
- pressing the `■` key while a folder is selected toggles it open/closed
- pressing the `■` key while a video is selected loads it into the next avaliable slot (note : you can see the first slot a video is loaded into on right colunm)
- pressing the `■` key while a video is selected loads it into the next available slot (note : you can see the first slot a video is loaded into on right column)
## `SAMPLER` display mode
this is the main display mode for using r_e_c_u_r. from this view you can see details of all the samples loaded into the sampler. a `bank` contains 10 `slots` labeled `0` - `9`. pressing the corrosponding `key` will load the `sample` in this `slot` to start when the current sample finishes. the `slot` of the currently playing sample is highlighted.
this is the main display mode for using r_e_c_u_r. from this view you can see details of all the samples loaded into the sampler. a `bank` contains 10 `slots` labelled `0` - `9`. pressing the corresponding `key` will load the `sample` in this `slot` to start when the current sample finishes. the `slot` of the currently playing sample is highlighted.
## `SETTINGS` display mode
@@ -53,3 +57,4 @@ this is where you can configure r_e_c_u_r's settings.
- pressing `■` on a setting will either cycle through it's `options` or run an `action` depending on its type (an `action` setting will always have value `run_action`)
[display_image]: display_parts.jpg