Repository navigation
Where is the Scripting Guide? #53
Description
"A scripting guide and API reference resides in Bitwig Studio under Help > Documentation > Developer Resources."
The Scripting Guide is no part any more in the current Bitwig versions. Where can I find the scripting guide?
Reacted by Flavelius, Merlin04, KrisTiasMusic, Henning Sprang, Peter Flannery, hlzr, Sʜɪᴍᴜʀᴀ Yū and Anntoin
Activity
kirkwoodwest commentedon Dec 9, 2023
Best bet to follow the masterful multi-part series by moss. https://www.youtube.com/watch?v=l4AuiQ8krQc&list=PLqRWeSPiYQ66KBGONBenPv1O3luQCFQR2&ab_channel=J%C3%BCrgenMo%C3%9Fgraber
aum7 commentedon Dec 16, 2023
please, bitwig, either :
file:///opt/bitwig-studio/resources/doc/control-surface/api/index.html
this is obviously local file
os : linux mint 21
bitwig : 5.1 latest & greatest
AndyJBuchanan commentedon May 27, 2024
Seconded. The API ref mentions this guide on the first page and googling is awash with exhortations to get this document from the Help menu. Where it isn't.
Lokua commentedon Jan 17, 2025
After upgrading Bitwig today, I find this absolutely infuriating.
ohcibi commentedon Feb 13, 2025
This issue needs higher priority. Javascript seems completely undocumented. Java only has the APIdoc (which seems outdated when following some of the deprecated noets) @abique @vosc @kurasu could you please say something about this? If there is nodocumentation about javascript, is there a repository for the library code? Such that we at least can have a look at the API and maybe even contribute some documentation?
It might also make sense to mark everything around controller scripting as beta or something similar (!nd as others have said, definitely remove the reference to non existing scripting guides. As a rule of thumb, don't reference other documents without a link. In other words: a reference to a document without a (working) link should become its own Jira Issue with at least default priority. If you want users to contribute to the incomplete controller support, you cannot ignore documentaiton.
ohcibi commentedon Feb 13, 2025
Just in case this isnt known. The video is 6 years old. Moss talks about api version 7. Bitwig today created an example project with
loadAPI(20)in it. Moss' js framework was already outdated by the time of the video. (oh and in fact the missing scripting guide was in bitwig at the mentined place back then)kirkwoodwest commentedon Feb 13, 2025
The video is still 100% relevant. everything is done the same way. This is the scripting guide. Trust me on this when I say the video series is better than anything Bitwig has provided before. Run it at 2x if you have to.
API 20 isn't out yet... its just the Beta version generating that code. API 19 is the one to use until its updated in the Maven Repo.
ohcibi commentedon Feb 13, 2025
there is no need to jump in to defend this video as nobody is attacking it. Nobody asked nor questioned whether or not the video is relevant and nobody asked about how much relevant it is either. Also there certainly is no doubt that this video is better than what bitwig currently provides, which - newsflash - is the point of this issue. The legitimatility of this video however, is - in context of this issue - indeed entirely irrelevant, as we are not discussing this video here but how to (re)add the information to bitwigs official documentation
Despite the fact that running a video 2x is not making it better than written documentation, I want to stress that this issue is not about that. Please do not add any more noise. We know the link. Thanks for sharing. But now lets make them maintainers fix the actual issue (or tell us how to help doing so)
First of: its also irrelevant because my point was the huge difference... Second: it just adds to this issue which is about (re)adding the missing information to bitwig. In case I havent mentioned it yet.
@abique @vosc @kurasu the issue is neither solved nor brought any further since my last question.
fabb commentedon Sep 4, 2025
You can use the (inofficial) typescript types as js reference: https://github.com/joslarson/typed-bitwig-api/blob/master/bitwig-api.d.ts
It‘s a bit outdated though, newest api version tag is v19.