ideoforms / AbletonOSC

Control Ableton Live 11 via Open Sound Control (OSC)
MIT License
397 stars 65 forks source link

Improve documentation of argument types #72

Open ideoforms opened 1 year ago

ideoforms commented 1 year ago

README does not include any indication of OSC argument types, which can be confusing. Add types (string, int, float, bool, etc) across the documentation.

Sternenherz commented 1 year ago

If possible, i would greatly appreciate example-usages in the documentation, so beginners and stupid people like myself can understand what "osc adress" and what "parameter" to put exactly where in Touch OSC, so that things actually work! Because i really struggle with using almost everything. The only things which work for me are some of those which don't need a parameter. Like /live/test. Or /live/song/stop_all_clips. Those work. But as soon as i try to do something like /live/clip/fire, i tried putting 1 1 behind it, 1,1, or track_1, clip_1 -> but nothing works... I would love to see VU Meters (track volumes), Tracknames, Clipnames, Clip-Playback Progress and much more, but i can't even do the simplest things. A tiny step-by-step tutorial of how to apply the documentation commands to real-life-usage with touch osc (or osc/Pilot) would be greatly appreciated! Thanks alot 1

markmarijnissen commented 1 year ago

The least effort way to help you out is to schedule a zoom call in which you share you screen and we'll figure out what's wrong. Then we record the final solution and share it for others. Should be do-able in a 30 minute call. Are you up for that? (reach me at my name at gmail dot com)

Sternenherz commented 1 year ago

Sounds awesome, i wrote you a mail ;)

zbynekdrlik commented 1 year ago

We are using touchosc with abletonosc. Many things already solved and using this in production. So I could help with that also.

Sternenherz commented 1 year ago

Well any help is appreciated! so here would be my contact: phielsagend and then the @ and then gmail com :)

MathiasSchneider-fr commented 1 year ago

I think a little TouchOSC (or open stage control) template with some examples of getters and setters would be a wonderful addition to the project!

stephenhuh commented 1 year ago

if @ideoforms is open to it, i'm happy to set up an official docs webpage with help from some of my friends. happy to use whatever gitbook or docusaurus or whatever is preferred

rp-bot commented 1 year ago

^ I would like to help with creating a read the docs webpage