Wiki: controller code sharing/examples

Bug #1130886 reported by rob
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mixxx
New
Wishlist
Unassigned

Bug Description

I'd make this myself, but I don't really have any experience making anything other than trivial edits to wikis, and I don't want to make a mess of things. I think it'd be useful to have a section of the Wiki dedicated to sharing controller script functions and code examples - somewhere that people could post commonly needed or particularly neat/useful functions, or code templates, along with an explanation (and possibly notes on the stuff people learned while developing those functions, troubleshooting, quirks, etc.), so that other people making controller mappings could easily re-use or modify that code for use in their own controller mappings... Maybe include a comments section where people could suggest improvements or additional funtionality.

I think this would make controller mapping easier, particularly for people new to Mixxx, would reduce duplication of efforts (since most controller scripts include a lot of the same functions anyway, why make people rewrite them every time), and would probably result in better overall mappings for Mixxx, since mappers could easily see the more interesting things that other people are doing and implement that functionality in their own mappings.

Obviously it's possible to just look at other people's mapping code, but that's kind of hard to decipher sometimes, and if you don't have the controller, you won't know what functionality is implemented in the mapping. I generally just wind up writing my own functions rather than trying to look through the other mappings for reusable code.

A few different examples of implementations of the same functionality would be useful as well - those could be collaboratively improved on, and we could wind up with a library of functions that people could relatively easily plug into their own mappings.

If someone created a section of the wiki, along with brief instructions and a template for adding a new page, I've got a few functions from my controller scripts I could post to start things off.

Tags: controllers
Revision history for this message
rob (another-rob) wrote :

...I guess this could also be implemented as a subforum under Controller presets/mappings, if that's a lot easier to implement than a new wiki section.

We'd probably wind up with a more useful and easily reviewable library of code if it was in the wiki, since old forum threads can get kind of confusing to scan through... But on the upside I suppose people might be more likely to contribute code to a subforum since it's easier than figuring out how to add to a wiki.

RJ Skerry-Ryan (rryan)
Changed in mixxx:
importance: Undecided → Wishlist
tags: added: documentation
removed: wishlist
tags: added: script
tags: added: controllers
removed: documentation script
summary: - Wishlist: [Wiki] controller code sharing/examples
+ Wiki: controller code sharing/examples
Revision history for this message
Swiftb0y (swiftb0y) wrote :

Mixxx now uses GitHub for bug tracking. This bug has been migrated to:
https://github.com/mixxxdj/mixxx/issues/6924

lock status: Metadata changes locked and limited to project staff
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.