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
Next revision
Previous revision
contributing_mappings [2018/10/17 09:54]
be.ing [After your mapping is merged] mixxx-devel is no longer used
contributing_mappings [2019/08/12 22:11] (current)
be.ing [Documenting the mapping]
Line 33: Line 33:
 ===== Documenting the mapping ===== ===== Documenting the mapping =====
  
-Post [[http://​mixxx.org/​forums/​viewforum.php?​f=7|on the forum]] early so users can find your mapping and give feedback as you develop it. For new mappings, list your controller on the [[hardware compatibility#​mappings in development|DJ Hardware Guide]] and start a wiki page for your controller. To make a wiki page, put double brackets around the name of your controller in the Hardware Guide, for example %%[[My Controller]]%%. Save your edit to the Hardware Guide page, then click on the red link in the Hardware Guide to create the new page. Add a picture of the controller (use the syntax %%{{URL to picture}}%% to embed a picture), a link to the manufacturer'​s ​website, a brief description, ​a link to the forum thread, and links to some reviews of the controller.+Post [[http://​mixxx.org/​forums/​viewforum.php?​f=7|on the forum]] early so users can find your mapping and give feedback as you develop it. For new mappings, list your controller on the [[hardware compatibility#​mappings in development|DJ Hardware Guide]] and start a wiki page for your controller. To make a wiki page, put double brackets around the name of your controller in the Hardware Guide, for example %%[[My Controller]]%%. Save your edit to the Hardware Guide page, then click on the red link in the Hardware Guide to create the new page. Wiki pages for controllers should include: 
 +  * A picture of the controller (use the syntax %%{{URL to picture}}%% to embed a picture) 
 +  * A link to the manufacturer'​s ​webpage for the controller (Use the syntax %%[[URL to link to|text of link]]%% for link) 
 +  * A link to the Mixxx forum thread ​for the controller 
 +  * Links to some reviews ​(optional, but nice to have) 
 +  * A brief description ​of the controller 
 +  * Notes about (in)compatibility with Windows, Linux, and macOSDocument whether it is USB class compliant (if it is compatible with macOS and the manufacturer does not provide a macOS driver, it is class compliant). 
 +  * Notes about any features of the controller that are not (yet) supported in Mixxx 
 +  * Any special instructions required for using the controller with Mixxx beyond the usual loading of the mapping in Mixxx'​s preferences 
 +  * The inputs and outputs of the audio interface if the device has one. Explain how to set these up with Mixxx. Usually this is just configuring channels 1-2 for master and channels 3-4 for headphones, but mention if there is anything else to set up. Document if the microphone inputs are available to the computer (more details [[#​microphone inputs|below]]). 
 +  * Labelled diagrams of the controller. Often you can find one in the manufacturer'​s manual. This is not strictly required but it is helpful for explaining the mapping. 
 +  * An explanation of how the mapping works
  
 You do not need to explain how Mixxx works; explain how the controller affects Mixxx. Feel free to link to the [[http://​mixxx.org/​manual/​latest/​|Mixxx manual]]. For example, to document a sync button, you do not need to explain how master sync works; just write that the button toggles master sync. You do not need to explain how Mixxx works; explain how the controller affects Mixxx. Feel free to link to the [[http://​mixxx.org/​manual/​latest/​|Mixxx manual]]. For example, to document a sync button, you do not need to explain how master sync works; just write that the button toggles master sync.
Line 48: Line 59:
 When the input signal is not available to computer, it is mixed in hardware with the main output without being digitized and routed to the computer. This has the advantage of not introducing the latency of routing the signal through an analog-to-digital converter, through the computer, and back out through the sound card's digital-to-analog converter (and saving the manufacturer the expense of putting an analog-to-digital converter in thousands of devices). However, users cannot record or broadcast using the microphone input on the controller. They would have to plug the microphone into a different sound card to record or broadcast the microphone signal. The sound card built into computer motherboards often has one microphone input jack, typically a 1/8" TS or TRS jack, often colored pink and labeled with a microphone icon, that can be used for this purpose. When the input signal is not available to computer, it is mixed in hardware with the main output without being digitized and routed to the computer. This has the advantage of not introducing the latency of routing the signal through an analog-to-digital converter, through the computer, and back out through the sound card's digital-to-analog converter (and saving the manufacturer the expense of putting an analog-to-digital converter in thousands of devices). However, users cannot record or broadcast using the microphone input on the controller. They would have to plug the microphone into a different sound card to record or broadcast the microphone signal. The sound card built into computer motherboards often has one microphone input jack, typically a 1/8" TS or TRS jack, often colored pink and labeled with a microphone icon, that can be used for this purpose.
  
 +Some controllers have a loopback/​mix record input that includes the microphone mixed with the master output from Mixxx (and often external audio inputs). If your controller has this, it should be configured for Mixxx'​s Record/​Broadcast input and this should be explained on the wiki page for the controller.
 ===== File naming convention ===== ===== File naming convention =====
 Please name your mapping files according to these conventions before making a pull request to have your mapping included in Mixxx. Please name your mapping files according to these conventions before making a pull request to have your mapping included in Mixxx.
contributing_mappings.1539784494.txt.gz · Last modified: 2018/10/17 09:54 by be.ing