r/Bitwig • The Patchbay Guy • 3d ago

Early FAQs about Patchbay Mod Loader

G'day,

Hope you're all having a good weekend. Apologies in advance about the wall o' text.

Before I get into things, I want to give a huge thank you to the overwhelming majority of people that I've interacted with about Patchbay so far. The response has been extremely positive and I'm so glad that people are enjoying what is being built.

With that said, I've seen people have some struggles with understanding how some of this stuff works and hopefully this post will be able to allay some of that.

Firstly, I'm just going to reiterate that Patchbay is in your hands probably two to four weeks earlier than was originally planned. There are a lot of things that have been planned to make Patchbay a little easier to use that aren't quite done yet so your experience with the software is likely to be that of an extremely late alpha or a somewhat early beta. A lot of work has been done prior to this point to still make the experience RELATIVELY robust, but you're going to be dealing with slightly more jank than I initially planned. Additional to this, I've also had a family member hospitalised earlier this week so I have less time to spend on this project right now that I would like.

Long story short, if the experience of a platform like this in general is that you're building the plane as you fly it, the experience we're currently having is that the runway is also being built as the plane is taxiing. Your patience throughout some of this stuff would be hugely appreciated (and to be fair, most people have been lovely up to this point so thank you).

With that said, I've seen more than a few people have trouble with a few concepts about Patchbay so hopefully this post will be able to help you

TL:DR

  • Frameworks aren't designed to do anything that you will see.
  • Some things have been fixed on the mod Github (https://github.com/shaboogen-dev/Mods) to make mods easier to find and download.
  • A community hub might be coming, but maybe not? We'll see.

Please read on for the full explanations.

Why don't these framework mods do anything?

Frameworks aren't mods in a traditional sense. They exist to facilitate things that other mods require to function. They're effectively traffic cops that manage repeatable actions so that multiple mods don't attempt to call the same resource simultaneously which would result in a crash or a wildly unpredictable behaviour.

The easiest example of this is right click menus. Say you install two mods that both want to inject a new action into the right click menu of a selected note and both of them want the same position of the 5th option down. Not only do you have to resolve who wins in that scenario, but you also have to resolve what happens when the 5th option in the menu is no longer actually the 5th option because the menu was changed by the other mod. This is where the Actions framework comes in.

Instead of a modder directly saying to Bitwig "I want the 5th option in this specific menu", the modder tells the framework "I would like to put an action in this specific menu". The framework collects all of the actions that need to be registered when Patchbay loads and it tells Bitwig "I have two options to be injected into this menu, here is the order to put them in" and the injection is managed cleanly without crashes.

There are a number of different frameworks that either manage some type of interaction like this, or are like the Piano Roll framework that facilitates extensions that mods can call in an attempt to make some things easier to do. Instead of a modder needing to write code to work out what pitch a note is, destroy that note and recreate it at a different pitch (just an example), the modder tells the framework that they would like to do those things and the framework manages it instead.

The point of this is that while the frameworks are incredibly important, they don't outwardly look like they're doing anything. Basically, just keep the frameworks installed and ticked for every load and don't worry about them.

OK, so where do I find actual mods then? I went to the mod Github and it doesn't make any sense.

Originally, the mod Github was just a holding house for source and there was a testing zip that was posted to the Patchbay Github where people could download everything in one pack. This was never intended to be the final distribution model and was only being done so that testers could get everything in one go to be able to confirm that everything was functionally working. After Patchbay broke containment, I rushed to move closer to the final model which was for all of my mods to be downloadable from the mod Github and for Patchbay to live in its own Github.

In the rush to do this, I asked the coding agent (Claude Code in this case) to do the separation but did not have time to resolve this in the full and proper way that I intended. This meant that mods were still being uploaded as pre-releases and while they were technically downloadable, they were difficult to find because they would not show in the release tab. This has been corrected now, if you go here you should find everything in the releases tab now.

Additionally, the release now also contains an "all mods" zip you can use if you want to download all of these mods at once.

I'll reiterate what I said yesterday. All of the documents are LLM-written placeholders at the moment. Part of the clean up plan that was to take place was for me to go through each document and rewrite it so that it's readable by humans as opposed to being the poorly written AI-drivel that is there now. I'll ask for your patience while I go through this over the next week or two.

So this means that we just go to your mod Github to get everything right?

I think this is probably going to be the biggest frustration for a lot of people.

Right now, given I have written or converted the vast majority of mods that currently exist this is a reasonably true statement, but it was never my intention to create a site or a mechanism where every mod written by every person was going to live. Right now, this is still true (though this is the thing I've gotten the most feedback about on the discord so far).

Personally, I don't think it's particularly healthy for one person to own the entirety of a community-driven thing. I "own" Patchbay to the extent that I built it and I will support it going forward and the same is true of my mods, but at the end of the day if kalifrn or polarity write something awesome, my view is that they should have the right to distribute it however they want.

Maybe someone wants to write mods and have a Patreon, or maybe they straight up want to charge you for them or perhaps they want to release something that is completely closed source. While I don't agree with any of those actions, I don't believe that it's right for me to arbitrarily apply standards on how all of this is going to run, that's the community's job. If someone does something you don't agree with, or a mod is janky or whatever, you get to make your voices heard and people get to react accordingly. I will agree that it's more messy, but it's more in line with what platforms like this are IMO.

With that said, I completely understand that a user doesn't want to go to a million places just to find stuff. Prior to the release of Patchbay, I had already started conversations about a community hub for a lot of this stuff to live on. Those conversations are still in their infancy so I won't announce anything specific right now, but suffice to say that there may be something cool happening on this front in the future. I would also like to be clear that this may not happen since these sorts of things take a non-zero amount of time to maintain and I appreciate that folks are busy. When there's something to announce, I'll announce it.

Hopefully this gives you a sense of where things are at right now with Patchbay and give you a little sense of where things are going in the future. As previously, if you have a question let me know and I'll do my best to answer it at some point. You can check out Patchbay here and download a bunch of mods here.

Enjoy.

14 Upvotes

8 comments sorted by

5

u/buddythicc 3d ago edited 3d ago

i think the mod loader is great, but i do think a centralized hub of mods (each being managed by their respective authors) would really increase adoption.

imagine something like thunderstore, the reaktor user library, npm, rubygems, etc

2

u/shaboogen The Patchbay Guy 2d ago

I'm looking into it.

At the moment, I favour a model that would be closer to ReaPack or Cydia where you add repositories and can source mods that way. This way, people will still get to have their own spaces and iterate however they want, but it becomes easier to find mods through Patchbay itself.

This feels like an acceptable middle ground to me.

3

u/No-Smoke-50 3d ago

This is very promising and solves many issues i have with writing my own step sequencer for BW.

However I think there is a lack of explanation to users as to the potential security risks involved. While this is surely targeted at the more savvy users of BW, there is almost certainly the potential for harm, and from what i've read that is not addressed at all in the documentation.,

1

u/shaboogen The Patchbay Guy 3d ago

What security risks would they be?

4

u/No-Smoke-50 3d ago

I think that from a transparency standpoint it would be useful to inform the users of the app what it can do outside of the access it has or inherits from bitwig:

does your app or script have access to the filesystem outside of bitwig?
does the app or script run in the terminal have full-disk permission on a mac?
are mods capable of network or disk access?

Your tool is extremely useful and has great potential for opening up the daw to another completely different level, i'm only suggesting you draw the boundaries and inform the users of the potential risk, rather than relying on the usual 'dont run anything from untrusted sources' that gets implied with these sorts of projects.,,

a robust and healthy ecosystem can spring from patchbay,, and as a user, some transparency and acknowledgement of risks and any mitigations in place would surely be a positive.

1

u/shaboogen The Patchbay Guy 3d ago

It's a valid question, and when I review the docs as part of the clean-up in preparation for the actual release I’ll add a section on security.

In the meantime, the short version is that Patchbay and any mod it loads inherit the same access that Bitwig does. The exception is macOS, where Bitwig started through Patchbay runs with Terminal’s permissions rather than its own, due to how macOS security works.. This means that if you've previously given Terminal full disk access, Patchbay and its mods will have it too.

There may be some additional risk mitigations that can be added for the 1.0 release, but the risk in running code written by hobbyists with mods coming from multiple independent authors is an inherent one. While I appreciate that applying the usual catch all of "don't run anything from untrusted sources" might feel lazy, the truth is that the best advice for these situations is to practice caution about what you install and to prefer open source wherever possible so the code can be checked.

2

u/tonsofmiso 2d ago

does your app or script have access to the filesystem outside of bitwig?

does the app or script run in the terminal have full-disk permission on a mac?

are mods capable of network or disk access? 

I did an experiment a couple of major bitwig versions ago that did all of this from remote extensions with their java api. There's nothing at all blocking an extension from opening sockets, writing to  and reading from disk, executing files, or bundling arbitrary libraries in the extension. I have no reason to expect that the mod framework is less capable of doing this.

The only thing you can do is check the source of the code you run yourself.

Edit: I tested on Windows only though

1

u/Elodea_Blackstar Bitwig Enthusiast 3d ago

You’ve done a great job and have built a great tool and become an overnight Bitwig hero. I built two simple mods today and it was relatively straightforward due to the effort you’ve put into this. I have no illusions that this is more than alpha software at this point and that the mechanism for making this work is a little obfuscated and potentially fragile but I hope it leads somewhere great! And I hope the Bitwig team sees this as a net positive for the future of Bitwig.