Home

Mixxx

Mixxx is open-source software with a broad community encompassing performing musicians, amateur DJs, internet radio broadcasters and casual users. The Mixxx Wiki contains useful information for users, developers and artists. It covers first steps if you are new to DJing, has a hardware guide to learn about supported controllers, provides help so you don't get stuck when running into trouble and is a great resource for developers.

Due to spam attacks, wiki editing has been restricted. However you are welcome to add information or change existing documentation. To do so, please send your suggestions by creating a new topic in the Documentation Stream on Zulip. If you find outdated, incorrect or incomplete information on the wiki, sending corrections would be very much appreciated.

User Documentation

Getting Started

• Beginner DJ Links
• DJ Hardware Guide
• Manual

Troubleshooting

• Troubleshooting
• Finding the Mixxx.log file can be helpful when Mixxx isn't working right. Please attach this file to bug reports and forum posts when asking for help.
• Adjusting Audio Latency

Getting Involved

• Reporting bugs is a great way to contribute to Mixxx, especially if you don't have programming skills
• Testing the latest features helps speed up development
• Getting Involved in Mixxx: Want Mixxx to be even more awesome? You don't need to be a programmer to help us.
• Google Summer of Code

Extras

• Live GNU/Linux distributions featuring Mixxx: Run Mixxx from a USB drive or DVD without having to install anything on the computer
• Live Calls with Skype and Mixxx
• MIDI clock output

Community Resources

• Mixxx website
• Development builds: Please help us test the latest code and report bugs. We try to make sure code is reasonably stable before including it in these, but only use development builds if you are comfortable using bleeding edge software. Do not upgrade to a new version without adequate time to test it before a performance.
• Blog
• List of open-source music production software

Contributing

• Bug tracker hosted on Github
• Internationalization: Help translate Mixxx into other languages
• Source code is hosted on GitHub

Communication

• Zulip chat: Ask for help, chat with users and developers. Native apps can be downloaded from Zulip's website and configured to use the server mixxx.zulipchat.com, or use the web app.
• Forums: Ask for help, listen to and share mixes, download and share controller mappings and skins
• mixxx-devel email list. Note that most project communication is on Zulip now, so you are more likely to get an answer to a question there.

Controller Mapping Documentation

• MIDI controller mapping file format: create or change a MIDI mapping file for your controller
• MIDI crash course
• Reverse engineering tips for DJ hardware
• Controller scripting with JavaScript: map advanced behaviors including jog wheel scratching, modifier (shift) buttons, and deck toggle buttons
• Components JS: JavaScript library to help with writing mapping scripts
• Contributing mappings: describes how to get your mapping included in Mixxx
• Controller mapping file locations
• Updating controller mappings: how to adapt old mappings for the latest version of Mixxx
• HID & USB Bulk controller mappings: create or change a mapping for your HID or USB bulk-transfer mode controller
• Mixxx Controls: List of Mixxx's controls that can be manipulated by controller mappings
• Controller Engine versions
• Controller mapping forum: search for mappings, share your mappings, and ask for help

Skin Documentation

• Creating Skins - the most up to date guide
• Skin Guidelines
• Skin Color Scheme Architecture
• Skin Color Schemes Tips and Tool
• On Icons and Images
• Skin System Changelog
• Skins forum: search for skins, share your skins, and ask for help

Developer Documentation

Compile Mixxx From Source Code

• Compiling on Linux
• Compiling on Windows
• Compiling on macOS
• Packaging / Making a Mixxx Installer

Getting Started

• Contribution Guidelines
• Coding Guidelines
• Developer Guide: high level overview of Mixxx's architecture
• Developer Tools
• Using Git
• Bug & feautre request tracker
• Bugfix Workflow
• Creating Backtraces: helpful for debugging crashes
• Code profiling to see what parts of the code are using more CPU time than others
• Learning Resources

Development Topics

• Minimum requirements policy
• Unit tests help prevent regressions. Writing tests is essential for new code!
• Iconic Tracks A list of tracks, useful for discussing Mixxx features
• Development Roadmap
• Feature Design Documents
• Google Summer of Code student projects and information.
• Google Code-in task list and information

Specs

• Pitch percentages for semitones and notes
• Engine Library format (for Denon Prime hardware)

Archives

• Press about Mixxx
• Developer meeting archives
• Bazaar (legacy) code browsing on Launchpad
• SVN (even more legacy) code browsing on Sourceforge