User Tools

Site Tools


contributing_mappings

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
contributing_mappings [2020/05/07 11:13]
be.ing [Design guidelines] explicitly prohibit making LEDs flash with the beat
contributing_mappings [2020/05/07 11:14] (current)
be.ing
Line 72: Line 72:
  
 If your controller was specifically designed for DJing and has labels on the controls, make your mapping do what the labels say. However, **you do not need to exactly follow the labels or mappings the manufacturer made for other software**. If you think there is a better way to map it or the manufacturer'​s mapping does not make sense with Mixxx (or just does not make sense), map it how you think it should be. You are encouraged to map additional features not included in the manufacturer'​s mappings, //but not at the expense of excluding functionality the controller is labeled for//. If your controller was specifically designed for DJing and has labels on the controls, make your mapping do what the labels say. However, **you do not need to exactly follow the labels or mappings the manufacturer made for other software**. If you think there is a better way to map it or the manufacturer'​s mapping does not make sense with Mixxx (or just does not make sense), map it how you think it should be. You are encouraged to map additional features not included in the manufacturer'​s mappings, //but not at the expense of excluding functionality the controller is labeled for//.
- 
-**Do not make any LEDs blink all the time.** This is //very// distracting. It might be okay to make LEDs blink to indicate a temporary state, but you should **not** make an LED flash with the beat. 
  
 Focus your mapping on functionality that is useful to have easy, quick access to while mixing. It is okay to leave parts of Mixxx unmapped that are not changed frequently while mixing; you do not need to map everything. The user can still use their mouse and keyboard to access functions not mapped on the controller. Focus your mapping on functionality that is useful to have easy, quick access to while mixing. It is okay to leave parts of Mixxx unmapped that are not changed frequently while mixing; you do not need to map everything. The user can still use their mouse and keyboard to access functions not mapped on the controller.
Line 82: Line 80:
  
 ==== Blinking LEDs ==== ==== Blinking LEDs ====
-Mappings should ​not blink LEDs for an extended period of time. If you would like to implement ​feature that blinks LEDs, make it an option that users can easily disable. Define a boolean variable at the very top of your JavaScript file (before any code or other comments) that users can change to ''​false''​ to disable the blinking or ''​true''​ to enable it. Put a comment above the variable definition explaining what the variable does and how to change it.+**Do not make any LEDs blink all the time.** This is //very// distracting. It might be okay to make LEDs blink to indicate ​temporary statebut you should **not** ​make an LED flash with the beat.
  
 === Play and cue button LEDs === === Play and cue button LEDs ===
contributing_mappings.txt ยท Last modified: 2020/05/07 11:14 by be.ing