View Full Version : Requesting user's opinion on documentation!

09-26-2010, 10:44 PM
Before adding new features, I would like to stop for a moment and give some love to the documentation section of this website. Some part are out of date, and some features are not even documented.

If there is something specific you would like to see in documentation, please use this thread to express your suggestions.



09-27-2010, 12:14 AM
Great idea for a sticky post :)

Variables, and how to use them.

Better explanation of argument routing — "Create a more complex OSC router" could use some more detail and background...


09-27-2010, 11:54 AM
Thanks Scott, exactly what I needed.

To everyone: keep 'em coming!

10-02-2010, 10:46 PM
My main interests would be:

- To see the OSC Routing section of the Reference Manual updated to match the current OSC Hosts window. I found it hard to follow when I was trying to create a document to control an application via OSC with a Wiimote. (I finally succeeded, though!)

- To see the Meta Events section updated to include all the current Meta Event types.

- Also, for some reason, I cannot figure out what the MIDI parameter Voice (formerly Index) does, even after reading past forum messages.

10-04-2010, 06:19 PM
Hi Yasha,

Thank you for these suggestions, I'll be working on the documentation during the week.

About your question: Voice (formerly Index), must be an integer value. It enables you to play polyphonic MIDI Notes using OSC messages. I'll write a blurb on that in the documentation as well.



10-08-2010, 03:00 PM
ok, so I've updated the documentation a bit.

Not quite yet to it, but the process is now ongoing.

The first pages really needed a lift so I've focused my attention on those basic parts.

The next step will be to write some new content based on your suggestions.

Finally I'll be able to complete some missing parts like the Motion Plus (it is almost obvious on how to use it, but I could have a work on it at least).

This should be done in two weeks.

Thank you for your patience.

10-11-2010, 02:56 PM
Just wrote a section about Variables (http://www.osculator.net/doc/manual:variables).

10-25-2010, 12:36 PM
About your question: Voice (formerly Index), must be an integer value. It enables you to play polyphonic MIDI Notes using OSC messages. I'll write a blurb on that in the documentation as well.

Im greatly looking forward to this! I have leaned a way to make chords (http://www.osculator.net/forum/threads/745-Noob-Question-about-Chords?p=5279&viewfull=1#post5279), but if there is a better way, Id love to know.

12-01-2010, 01:58 PM

I would like your documentation downloadable in PDF format !

and why not a translation in.... french for example ! (you are french aren't you !!?)
because MIDI is a bit complicated and all in english is not easy to learn and understand configurations

thank you!
your site an app is fine and very useful !!:)

04-13-2011, 08:40 PM
I second the request for a PDF version - also some documentation on the Scaling page (e.g. In. min/In. max/Cap/Out. min/Out. max) would be welcome - I'm wrestling with it right now actually; see other post...

04-30-2011, 09:42 PM
I would like some information about the "Enable Combine" Event

05-02-2011, 09:57 PM
Some examples of how the MIDI events work would be nice. At first I though 'pitch' meant pitchbend in this context. Perhaps 'note' would be better than 'pitch' to avoid any confusion. Still in this context, I'm not sure what 'voice' mean (even after reading you previous comment ;-)...

05-02-2011, 10:08 PM
Yes, that feature should be documented somehow.
The voice parameter enable you to play notes polyphonically.
Each note is identified by a voice number.

I think however that the names are appropriate.
Pitch and Voice are common terms in MIDI jargon.

Thank you for your suggestions, I will try to document the Voice parameter in a better way.

05-02-2011, 10:25 PM
Your chosen terms are probably the right ones. It's just me who gets confused easily... ;-) A bit of documentation on the MIDI aspects would be nice though.

05-11-2011, 07:56 AM
i'd like to "third" the request for downloadable documentation. doesn't have to be pdf, could be html. i was just in the situation where i was on a long train ride and working on some programming, but got stuck because i couldn't access the documentation. there are lots of situations like that, the last thing you want is to be on stage somewhere and have a problem just before the show starts, and you can't figure it out because you have no internet connection...


05-11-2011, 11:03 AM
I will include the documentation as part of the application and update it with the missing bits for the next release (2.11).

07-09-2011, 12:20 PM
I'm sure this has been asked for before, but I'd like to ask again for a downloadable manual and tutorial guide, to take someone from absolute beginner to OSCulator expert. Lots of examples, lots of downloadable templates to fiddle with, with everything explained.

I have gone through the documentation, and to be honest, I found it a bit of a struggle to find the answers to simple questions there, particularly in terms of integration with TouchOSC surfaces one may have designed.

I know this is a massive undertaking, but in terms of teaching this stuff (I do this a lot!) there just isn't the simple, understandable information out there on OSC and this would be a great place to start with such a great piece of software!

07-09-2011, 12:26 PM
Hi Phinland,

This is exactly what I have started to do a month ago, at least I'm trying my best to rewrite the user manual :)
You can already download an initial edition of the PDF manual here:

It is not complete, but when it will, OSCulator 2.11 will be released.

The difficulty is that OSCulator is a "general purpose" software in some sense, and I can't be specific to TouchOSC, or any software. Regarding TouchOSC, there are already a lot of examples in the Sample Library, and each example is commented in the accompanying Notepad window.

I hope this answers your request.

Best Regards,

07-12-2011, 01:43 PM
Hi Cam, Thanks as always for your input. To reiterate our email exchange, I think the new beta manual is a massive step forward. A really great pair of additions would be the functions appendix and some incremental worked example projects, moving from absolute MIDI/OSC/OSCulator beginner to expert in several increasingly complex stages. Cheers!