Hercules DJ Controller Driver for Linux
=============================

This is a Linux userspace driver for some Hercules DJ controllers.

Originally this was a part of Mixxx,
but in order to issue more timely updates
(not bound to the Mixxx release schedule),
it is now a standalone project.
That means you can use it with any version of Mixxx,
without needing to recompile anything other than this driver.

Since it runs in userspace,
you don't need to keep modifying your kernel to keep it working.
And if the driver crashes,
the rest of your system keeps running.
But please tell me if it crashes!


Supported Controllers
---------------------

The driver currently supports:

* Hercules DJ Control MP3 e2
* Hercules DJ Control Steel

Support is planned for:

* Hercules DJ 4Set
* Hercules Console Mk4 (if I can find one cheap enough)

Things I won't support:

* Hercules Console Mk2 (already works with HID code in Mixxx)
* Hercules RMX (already works with HID code in Mixxx)
* Hercules DJ Control Instinct (already works with Midi code in Mixxx,
  although I *will* be contributing a mapping for it)


If you have a Hercules device that doesn't "just work" with Mixxx,
send me an email, there's a good chance I can support it with this driver.

How To Compile
--------------

    sudo apt-get install libasound2-dev libusb-1.0-0-dev libfaad-dev libmp4v2-dev
    make


How To Run
----------

Also make sure your user can read and write to raw USB devices.

The following are instructions for udev-based systems (almost every Linux distribution).

  - Create the file `/etc/udev/rules.d/hercules-usb.rules` with the following content:

    `SUBSYSTEM=="usb_device", SYSFS{idVendor}=="06f8", MODE="0666"
    SUBSYSTEM=="usb", ATTRS{idVendor}=="06f8", MODE="0666"`

  - Restart udev: 

    `sudo /etc/init.d/udev restart`

See [this Mixxx wiki page](http://mixxx.org/wiki/doku.php/hercules_dj_control_mp3_e2#usb_hid) for more information.

Currently, the driver must be started **after** you plug in a device.
Just run `./hdjd` and it will tell you what it found.


Current Issues
--------------

The driver is pretty crappy right now.
If you email me, I'm a lot more likely to fix things.
Even if you just say "hi, I'm using your Hercules driver".

* Driver must be launched after device is plugged in
* It locks up and crashes sometimes

If you find a problem, please, please, pretty-please,
email me <neale@woozle.org>.
Posting on the Mixxx Community Forums is fine too,
maybe someone there can help you,
but I don't check the forums very often.
Sorry.


Thanks
------

Thanks to Guillemot (makers of the Hercules controllers) for sending me
a whole bunch of controllers so I could make a better driver.

Thanks to the Mixxx project for connecting me with Guillemot,
and for providing something interesting to use this driver ;-)

Contact Me
----------

Neale Pickett <neale@woozle.org>