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/03/24 07:53]
hlzhs
contributing_mappings [2020/03/24 07:55] (current)
hlzhs
Line 26: Line 26:
 === Working on your mapping and other branches simultaneously === === Working on your mapping and other branches simultaneously ===
 Refer to instructions on the [[Using Git#Working on mappings and skins separately from other changes|Using Git]] page. Refer to instructions on the [[Using Git#Working on mappings and skins separately from other changes|Using Git]] page.
 +
 ==== Submitting your mapping for review ==== ==== Submitting your mapping for review ====
  
Line 118: Line 119:
  
 Some controllers have integrated sound cards that do not have knobs or buttons on the device that control the sound card's outputs, but the sound card's outputs can be controlled through the [[operating system mixer]] program. In that case, MIDI/HID signals for these functions should //not// be mapped to the software gains in Mixxx. Unfortunately,​ there is no reliable, cross-platform way for Mixxx to access the controls accessible to the OS' mixer program, so these controls cannot be mapped to control the sound card. Users should be directed to the [[operating system mixer]] wiki page for instructions on how to adjust their output levels. Although this is less convenient than mapping the software gains in Mixxx, it makes a substantial difference to the sound quality users will hear from Mixxx. Some controllers have integrated sound cards that do not have knobs or buttons on the device that control the sound card's outputs, but the sound card's outputs can be controlled through the [[operating system mixer]] program. In that case, MIDI/HID signals for these functions should //not// be mapped to the software gains in Mixxx. Unfortunately,​ there is no reliable, cross-platform way for Mixxx to access the controls accessible to the OS' mixer program, so these controls cannot be mapped to control the sound card. Users should be directed to the [[operating system mixer]] wiki page for instructions on how to adjust their output levels. Although this is less convenient than mapping the software gains in Mixxx, it makes a substantial difference to the sound quality users will hear from Mixxx.
 +
 +
 ===== Coding conventions for Javascript ===== ===== Coding conventions for Javascript =====
 Javascript is a very flexible programming language. It has some good features, but there are also a number of features that have confusing syntax and/or encourage bad programming practices. Using these features makes it easier for bugs to go unnoticed in your code. Having guidelines about coding style makes code in Mixxx easier to read and more consistent. Javascript is a very flexible programming language. It has some good features, but there are also a number of features that have confusing syntax and/or encourage bad programming practices. Using these features makes it easier for bugs to go unnoticed in your code. Having guidelines about coding style makes code in Mixxx easier to read and more consistent.
Line 126: Line 129:
   * Use 4 spaces to indent, not tab characters.   * Use 4 spaces to indent, not tab characters.
   * Always put ''​var''​ before variable declarations to avoid accidentally declaring global variables.   * Always put ''​var''​ before variable declarations to avoid accidentally declaring global variables.
-  * Do not write one-line ''​if''​ statements or one-line functions.+  * Do not write one-line ''​if''​ statements or one-line functions... :note: For more information,​ go to 
 +          `<​https://​mixxx.org/​wiki/​doku.php/​midi_scripting>​`_ 
 +          and `<​https://​mixxx.org/​wiki/​doku.php/​hid_mapping_format>​`_. 
 + 
 + 
   * Always use brackets for ''​if''​ statements. Put the opening ''​{''​ on the same line as the conditional expression and the closing bracket ''​}''​ on its own line.   * Always use brackets for ''​if''​ statements. Put the opening ''​{''​ on the same line as the conditional expression and the closing bracket ''​}''​ on its own line.
   * Put ''​else''​ statements on the same line as the previous closing ''​}''​   * Put ''​else''​ statements on the same line as the previous closing ''​}''​
contributing_mappings.txt · Last modified: 2020/03/24 07:55 by hlzhs