Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Controller "Preset" with "Mapping" #314

Merged
merged 3 commits into from
Dec 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions source/chapters/advanced_topics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Adding support for your MIDI/HID Controller
With several dozens of DJ controllers supported out-of-the-box, Mixxx gives you
comprehensive hardware control for your DJ mixes, see :ref:`control-midi`.

Support for additional devices can be added to Mixxx by creating a new preset
Support for additional devices can be added to Mixxx by creating a new mapping
file. This file tells Mixxx how to translate, or map, :term:`MIDI`/:term:`HID`
messages from a controller into commands that Mixxx understands.

You can download and share custom controller presets in the
You can download and share custom controller mappings in the
`Mixxx User customizations forums <https://mixxx.org/forums/viewforum.php?f=6>`_.


Expand All @@ -33,7 +33,7 @@ Controller Wizard

Mixxx Controller Wizard - Mapping a control

By far, the easiest way to create a new MIDI preset is by using the Controller
By far, the easiest way to create a new MIDI mapping is by using the Controller
Wizard.

#. Connect your controller(s) to your computer
Expand Down Expand Up @@ -71,14 +71,14 @@ There are also some advanced options in the Midi Wizard you may need to use:
* Jog Wheel / Select Knob: Use this for knobs that don't have a beginning or an
end, but spin continuously.

The Controller wizard saves the new preset to the following file paths:
The Controller wizard saves the new mapping to the following file paths:

* Linux: :file:`/home/<username>/.mixxx/controllers`
* macOS: :file:`/Users/<username>/Library/Application\\ Support/Mixxx/controllers`
* Windows: :file:`%LOCALAPPDATA%\\Mixxx\\controllers`

You can then modify the XML file it creates (or any of the ones that
ship with Mixxx) if you'd like to fine-tune it or add more presets. For more
ship with Mixxx) if you'd like to fine-tune it or add more mappings. For more
information, go to
`<https://github.com/mixxxdj/mixxx/wiki/MIDI-Controller-Mapping-File-Format>`_.

Expand Down
32 changes: 16 additions & 16 deletions source/chapters/controlling_mixxx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,27 @@ hardware devices used to control audio applications. Many DJs prefer the
hands-on feel of a controller with Mixxx because it can feel similar to using a
real mixer and turntables or :term:`CDJ`.

.. _control-load-preset:
.. _control-load-mapping:

Loading a controller preset
---------------------------
Loading a controller mapping
----------------------------
.. figure:: ../_static/Mixxx-200-Preferences-Controllers.png
:align: center
:width: 75%
:figwidth: 100%
:alt: Mixxx Preferences - Loading a controller preset
:alt: Mixxx Preferences - Loading a controller mapping
:figclass: pretty-figures

Mixxx Preferences - Loading a controller preset
Mixxx Preferences - Loading a controller mapping

Without loading the correct preset, your controller does not work with Mixxx.
Without loading the correct mapping, your controller does not work with Mixxx.

#. Connect your controller(s) to your computer
#. Start Mixxx
#. Go to :menuselection:`Preferences --> Controllers`
#. Select your device from the list of available devices on the left, and the
right pane will change
#. Select the mapping for your controller from the :guilabel:`Load Preset`
#. Select the mapping for your controller from the :guilabel:`Load Mapping`
drop-down menu
#. Make sure that the :guilabel:`Enabled` checkbox is ticked
#. Click :guilabel:`Apply` and Mixxx can now be controlled by your controller(s).
Expand Down Expand Up @@ -144,7 +144,7 @@ report` on our `Bug Tracker`_ or tell us about it on our mailing list, forums,
or :term:`IRC` channel. Device support varies for each supported :term:`OS
<operating system>`, so make sure to consult the documentation of the device.

.. hint:: Additional mappings are available in the `Controller presets forum`_.
.. hint:: Additional mappings are available in the `Controller mapping forum`_.

.. seealso:: Before purchasing a controller to use with Mixxx, consult our
`Hardware Compatibility wiki page`_. It contains the most
Expand All @@ -153,15 +153,15 @@ or :term:`IRC` channel. Device support varies for each supported :term:`OS

.. _Hardware Compatibility wiki page: https://github.com/mixxxdj/mixxx/wiki/Hardware-Compatibility
.. _Bug Tracker: https://bugs.launchpad.net/mixxx
.. _Controller presets forum: https://mixxx.org/forums/viewforum.php?f=7
.. _Controller mapping forum: https://mixxx.org/forums/viewforum.php?f=7

Installing a preset from the forum
----------------------------------
Installing a mapping from the forum
-----------------------------------
To use a controller mapping that did not come bundled with Mixxx, place the
controller mapping in your User Presets folder. This is the folder called
"controllers" inside your User Preferences folder. To open your User Presets
controller mapping in your User Mappings folder. This is the folder called
"controllers" inside your User Preferences folder. To open your User Mappings
folder, go to :menuselection:`Preferences --> Controllers` and click the
:guilabel:`Open User Preset Folder` button. Alternatively, navigate to the
:guilabel:`Open User Mapping Folder` button. Alternatively, navigate to the
folder in your :term:`OS <operating system>` file browser:

* GNU/Linux: :file:`/home/<username>/.mixxx/controllers`
Expand All @@ -176,8 +176,8 @@ do this varies with each version of Windows).
If the mapping was posted as a :file:`.zip` file, first extract the :file:`.zip`
file by right clicking on it in your file browser and selecting the option for
extracting an archive or compressed folder. Copy the :file:`.xml` file into your
User Preset folder. If there is a :file:`.js` file, also copy that to your
User Preset folder. Restart Mixxx and :ref:`load the preset <control-load-preset>`.
User Mapping folder. If there is a :file:`.js` file, also copy that to your
User Mapping folder. Restart Mixxx and :ref:`load the mapping <control-load-mapping>`.

Map your own controller
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion source/chapters/hardware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ devices can be used as both a controller and :ref:`hardware mixer

Mixxx can work with any :term:`MIDI` or :term:`HID` :term:`controller` as long
as there is a mapping file to tell Mixxx how to understand the controller's
signals. Mixxx comes bundled with a number of MIDI and HID mapping presets,
signals. Mixxx comes bundled with a number of MIDI and HID mappings,
which are listed in the :ref:`Hardware Manuals <hardware-manuals>` section.
For controllers that Mixxx does not yet support, you can `search the forum
<https://mixxx.discourse.group/c/controller-mappings/10>`_ to see if anyone has
Expand Down
2 changes: 1 addition & 1 deletion source/hardware/controllers/american_audio_vms4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Setup
and button area.

10. Click the Enable checkbox in the right pane
11. Click the drop-down and choose the American Audio VMS4 preset
11. Click the drop-down and choose the :guilabel:`American Audio VMS4` preset
12. Click OK and the controller should light up. (In 1.9.x, the
controller will light up when you load a track to a deck.)
13. Continue reading below to know how everything is mapped
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The controller is a class compliant MIDI controller, so you should be
able to just plug it in and it should be recognized in Mixxx. No need
for drivers.

Make sure to select the correct preset for the controller and enable it.
Make sure to select the correct mapping for the controller and enable it.

Audio Channels
~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion source/hardware/controllers/keith_mcmillen_quneo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The mapping is included with the QuNeo installer, make sure to click the
“Mixxx” check box when prompted during the installation. Alternatively
download the Installer from
`www.keithmcmillen.com <http://www.keithmcmillen.com/QuNeo/downloads/>`__.
The MIDI mapping preset goes with QuNeo’s factory preset number 12. To
The MIDI mapping goes with QuNeo’s factory preset number 12. To
change the factory preset, select the blue MODE button on the device and
press tab #12. Also see `Youtube - Setting up Mixxx with
QuNeo <https://www.youtube.com/watch?v=sw4Cnko-nOU>`__.
Expand Down
4 changes: 2 additions & 2 deletions source/hardware/controllers/reloop_terminal_mix_series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ you can set to your liking:

- ``pitchRanges``: Set the pitch slider range each time you toggle it.

Just open the ``controllers/Reloop Terminal Mix 2-4.js`` file in your favorite
Just open the :file:`Reloop Terminal Mix 2-4.js` file in your favorite
text editor and you’ll see these variables right near the top. Edit and save and
Mixxx will automatically reload the preset.
Mixxx will automatically reload the mapping.


Deck controls
Expand Down
11 changes: 2 additions & 9 deletions source/hardware/controllers/stanton_scs3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Stanton SCS.3d “DaScratch”
- `Walk-through video! <http://www.youtube.com/watch?v=8DUpTikA8u0>`__

.. versionadded:: 1.7
.. versionadded:: 2.0
Alternate mapping with many more visual effects (flashing lights) and different behavior.

Default Mapping
---------------
Expand Down Expand Up @@ -290,15 +292,6 @@ You are in this mode only **while holding down the Deck button**, unless the con
value
- Press Deck + Play together to change the active deck

Alternate mapping
-----------------

An alternate preset was provided by a member of the community for Mixxx 2.0. It
has many more visual effects (flashing lights) and behaves somewhat differently
from the official preset above. To use this alternate preset in Mixxx 2.0,
select the preset labeled **Stanton SCS.3d (alternate)** from the drop down menu
in the controller preferences.

General controls
~~~~~~~~~~~~~~~~

Expand Down