Ctrlr – Step by step guide (in DEV version)

Home Forums General News and releases Ctrlr – Step by step guide (in DEV version)

This topic contains 26 replies, has 13 voices, and was last updated by goodweather goodweather 3 months ago.

Viewing 20 posts - 1 through 20 (of 27 total)
  • Author
    Posts
  • #53939
    goodweather
    goodweather
    Participant
    • Topics: 38
    • Replies: 321
    • Total: 359
    • ★★

    *** This is an outdated topic; don’t use anymore ***
    *** Look at the main Step by Step guide topic or contact me by PM for other suggestions ***

    Hi,
    this is the “in development” topic for the Ctrlr – Step by step guide.

    Of course, all contributors are welcome but for easier management purpose I propose to publish the releases.
    Use the styles I defined (Alt-Ctrl-Shift-S) so that we have an uniform look:

    • Normal: for all paragraphs
    • Paragraph bullet: starting a new paragraph where next ones are bullets
    • List bullet: level1 bullet
    • List bullet2: level2 bullet
    • Heading3: headers
    • Picture: for pictures
    • Code: for code extracts

    The table of content is adapted automatically.

    In the appendix, you can add new topics to be added later on, identified bugs to forward to Atom…

    This first post will always contain the last “in dev” version in Word.

    • This topic was modified 3 months, 2 weeks ago by goodweather goodweather. Reason: Outdated topic
    Attachments:
    You must be logged in to view attached files.
    #54203
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    I’ll try to do some work on this tonight. I’ll mark my changes using Track Changes so you can incorporate the changes into the master document.

    I’ll add a procedure on how to create and assign a method to a modulator/panel

    I’ll add a number of code examples.

    LUA Method for sending MIDI from a modulator.
    Using Tables for Value Lookups from a custom list (because setMappedValue and getMappedValue doesn’t seem to work for fixed image sliders. This also shows how to build and use a general function in ctrlr
    LUA Methods for setting Modulator and Panel Properties and how to work out how to reference them.
    LUA Method for setting modulator values
    Some discussion about Initializing the Panel, global variables and some strategies about being efficient with LUA programming (though I’ve still got lots to learn here).

    The Puppeteer
    http://godlike.com.au

    #54262
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Have made some modifications. Please go through the changes and update your initial post.

    Attachments:
    You must be logged in to view attached files.

    The Puppeteer
    http://godlike.com.au

    #54281
    urbanspaceman
    urbanspaceman
    Participant
    • Topics: 7
    • Replies: 38
    • Total: 45

    Thanks Puppeteer!

    #54456

    memorysplice
    Participant
    • Topics: 14
    • Replies: 59
    • Total: 73

    Thank you!!!

    #54464
    zeoka
    zeoka
    Participant
    • Topics: 70
    • Replies: 459
    • Total: 529
    • ★★★

    thank you

    #54740
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Another update. Added a bit packing function example. It should be pretty efficient as it’s all and, or’s and bit shifting.

    Attachments:
    You must be logged in to view attached files.

    The Puppeteer
    http://godlike.com.au

    #54742
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Missed a couple of minor formatting issues. Also did an intro.

    Attachments:
    You must be logged in to view attached files.

    The Puppeteer
    http://godlike.com.au

    #54872
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Added a short section on exporting and solving some resource display issues.

    Attachments:
    You must be logged in to view attached files.

    The Puppeteer
    http://godlike.com.au

    #54875
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Sorry about all the small edit changes. I save and upload, and find something else that needs fixing.

    This time, added a note about using vertical rather than horizontal knob file exports from jKnobMan.

    Attachments:
    You must be logged in to view attached files.

    The Puppeteer
    http://godlike.com.au

    #55834

    Icchan
    Participant
    • Topics: 0
    • Replies: 2
    • Total: 2

    Hi.

    As my first post (after spending time trying to get a grip on things) this might be a bit “negative”, but I would suggest one thing:

    Use version control software.

    Wouldn’t it be better for the organization of all the changes and different contributors to use version control system, for example Git? This would make sure that all changes are tracked and diffs can be made easily, and things can be merged in ordinarily fashion. Thus it would make it easier to maintain the project and to have good document in one central location (GitHub?) that’s public on the net and one can easily find it using Google.

    It took me many hours of just scourging through the forums to accidentally come across this thread. Google doesn’t find it, and since these forums don’t have stickies, it could easily get under a ton of other posts and be forever hidden / forgotten.

    And this document is definitely something that shouldn’t be lost to the depths of the forum.

    Thank you for your understanding and please, don’t take this too harshly. Just something that many years of software development and open source projects have thought:

    * Centralize all information to one place.
    * Make it easily available to all contributors.
    * Make sure it can be found with Google.
    * Use version control software, it saves lives.

    🙂

    • This reply was modified 2 years, 11 months ago by  Icchan.
    • This reply was modified 2 years, 11 months ago by  Icchan.
    #55921
    goodweather
    goodweather
    Participant
    • Topics: 38
    • Replies: 321
    • Total: 359
    • ★★

    Hi,
    thx for all updates Puppeteer!

    TO ALL: please bear in mind that this is the IN DEV version! The idea with this thread was to gather info then publish it as a new version of the “official” thread (official is very bad naming…).

    “Official” thread is: http://ctrlr.org/forums/topic/ctrlr-step-by-step-guide/

    #56214

    m.tarenskeen
    Participant
    • Topics: 26
    • Replies: 98
    • Total: 124
    • ★★

    Thanks for working on this document.
    But I agree with lcchan that open source development, which includes not only software but also documentation, should be done in an open source version control system like git. And I would expect to find stable versions of such documentation easily in the ctrlr website below the “Documentation” and/or the “Downloads”, not hidden inside a forum thread.

    Having said that: Keep up the good work! Good documentation is essential for the usability, power, and future of ctrlr!

    #56953

    jon23
    Participant
    • Topics: 0
    • Replies: 3
    • Total: 3

    Maybe try github pages?
    https://help.github.com/categories/github-pages-basics/

    Using it with Jekyll is pretty sweet.

    #57054
    Puppeteer
    Puppeteer
    Participant
    • Topics: 14
    • Replies: 178
    • Total: 192
    • ★★

    Please bear in mind that this is a user originated tutorial, not an official manual, and we are far from Ctrlr experts. I’m having a look at github at the moment and it may be workable for us, but in the meantime while we are still authoring the main sections, we might put it on onedrive to make it easier for us to build.

    Once we’ve filled out most of the current sections, I’ll try to get in touch with Atom about including it in the official documentation section.

    The Puppeteer
    http://godlike.com.au

    #72139
    rio
    rio
    Participant
    • Topics: 3
    • Replies: 7
    • Total: 10

    Hi,

    Are there any news about the wok process of that guide?
    I appreciate your work a lot 😉

    Regards
    Rio

    #72140
    goodweather
    goodweather
    Participant
    • Topics: 38
    • Replies: 321
    • Total: 359
    • ★★

    Thx. Actualy you should not look to this post but to the http://ctrlr.org/forums/topic/ctrlr-step-by-step-guide/ one.

    Yes, I’m working on it but in parallel (besides my business work) I’m also modifying the Pro2 panel and making a P12 panel and learning my synths and…
    But no worry, it will come out. I guess somewhere in August.
    I have rewritten the existing part by adding more details and info. I’m using my Pro2 as example as I came to a dead end with the Sub37.
    I have also added a lot of pages on Lua programming and methods (all tips and tricks I’m using in the Pro2 panel).
    There is really a lot to explain…

    So, thx for your support and just be patient 😉

    #72160
    rio
    rio
    Participant
    • Topics: 3
    • Replies: 7
    • Total: 10

    thx thx, can you pls add then an article about programming with mouse events too, like you have mentioned here:

    http://ctrlr.org/forums/topic/how-to-get-the-mouse-event-object-in-any-method/

    regards,
    rio

    • This reply was modified 1 year, 2 months ago by rio rio.
    • This reply was modified 1 year, 2 months ago by rio rio.
    #72165
    goodweather
    goodweather
    Participant
    • Topics: 38
    • Replies: 321
    • Total: 359
    • ★★

    Yes. I had already foreseen the paragraph.
    Thx for mentioning!

    #72166

    loziniak
    Participant
    • Topics: 0
    • Replies: 3
    • Total: 3

    Maybe try github pages?

    Recently there is a “Documentation” project on Stack Overflow. We could use it, but first we probably need some questions tagged “ctrlr”. Ctrlr is a sort of visual programming language, and a programming framework from Lua point of view. How many of you use Stack Overflow?

Viewing 20 posts - 1 through 20 (of 27 total)

You must be logged in to reply to this topic.

There is currently 1 user and 14 guests online
Quimquim
Forum Statistics
Threads: 2,139, Posts: 15,095, Members: 10,956
Most users ever online was 5 on March 28, 2018 6:11 pm
Do NOT follow this link or you will be banned from the site!