Running scripts on append/link #78794

New Issue

Demeter Dzadik · 2020-07-10T14:21:35+02:00

Demeter Dzadik commented

2020-07-10 14:21:35 +02:00

(I mentioned this at lunch and @dr.sybren said I should make a design task here c: )

Problem

Most production rigs come with their own scripts, whether it's just for UI purposes or have actual functionality. It's standard practice for riggers to make these text datablocks a dependency of the rig to make sure that it's brought along when the rig is appended or linked somewhere. However, such scripts will not run on append or link.

This introduces a piece of poor UX for animators, which in my experience results in a huge amount of confusion. The animator would have to save and reload the file, or open a text editor and run the script file, but they have no reason to know that they have to do either of these, unless the rigger tells them so. @Hjalti and @PabloFournier probably remember running into this on many occasions.

Proposal

My idea is to add a piece of functionality to the append and link operators; A "Run Scripts" bool param, enabled by default, with a tooltip like "Execute scripts which are set to register on file load after appending/linking". Can probably come up with better wording, but I guess you get the idea; Appending or linking(directly or indirectly) a text datablock with the register checkbox enabled(use_module==True), will also execute it.

If the user has Auto-Run Python Scripts user preference disabled, it should throw up the usual pop-up to request permission to run the script.

An example file with a rig and rig UI script, all ready to be linked/appended:
custom_rig_ui.blend

Thoughts? Are there other use cases? Are there any scenarios where this would cause problems?

(I mentioned this at lunch and @dr.sybren said I should make a design task here c: ) # Problem Most production rigs come with their own scripts, whether it's just for UI purposes or have actual functionality. It's standard practice for riggers to make these text datablocks a dependency of the rig to make sure that it's brought along when the rig is appended or linked somewhere. However, such scripts will not run on append or link. This introduces a piece of poor UX for animators, which in my experience results in a huge amount of confusion. The animator would have to save and reload the file, or open a text editor and run the script file, but they have no reason to know that they have to do either of these, unless the rigger tells them so. @Hjalti and @PabloFournier probably remember running into this on many occasions. # Proposal My idea is to add a piece of functionality to the append and link operators; A "Run Scripts" bool param, enabled by default, with a tooltip like "Execute scripts which are set to register on file load after appending/linking". Can probably come up with better wording, but I guess you get the idea; Appending or linking(directly or indirectly) a text datablock with the register checkbox enabled(`use_module==True`), will also execute it. If the user has Auto-Run Python Scripts user preference disabled, it should throw up the usual pop-up to request permission to run the script. An example file with a rig and rig UI script, all ready to be linked/appended: [custom_rig_ui.blend](https://archive.blender.org/developer/F10428949/custom_rig_ui.blend) Thoughts? Are there other use cases? Are there any scenarios where this would cause problems?

Demeter Dzadik commented

2020-07-10 14:21:35 +02:00

Added subscribers: @PabloFournier, @Hjalti, @dr.sybren, @Mets

Ben commented

2020-07-10 14:39:55 +02:00

Added subscriber: @TheOldBen

Ben commented

2020-07-10 14:39:55 +02:00

Very reasonable proposal. Would love to not have to reload the files every time. It has been a point of confusion for many of my rig users who come to complain about missing rig controls.

Juan Pablo Bouza commented

2020-07-10 16:52:24 +02:00

Added subscriber: @jpbouza-4

Juan Pablo Bouza commented

2020-07-10 16:52:24 +02:00

Hi! Ok, here go my two cents..

I think that anything that makes the scripts work will be welcome, but to me, even the workflow we have right now is a bit obscure to me...

So this is just a crazy idea, but what if we have a new type of object specific property that would let you add scripts to them... Like an object script datablock where each object can have its own scripts... I don't know, just ignore me if it doesn't make sense, hehe.

Hi! Ok, here go my two cents.. I think that anything that makes the scripts work will be welcome, but to me, even the workflow we have right now is a bit obscure to me... So this is just a crazy idea, but what if we have a new type of object specific property that would let you add scripts to them... Like an object script datablock where each object can have its own scripts... I don't know, just ignore me if it doesn't make sense, hehe.

Demeter Dzadik commented

2020-07-10 17:21:44 +02:00

For those not in the know, you can add a custom property referencing a text datablock (or any other datablock) with something like this in the PyConsole:
bpy.context.object['my_script'] = bpy.data.texts['rig_ui.py']

And I agree, it feels like a weird workflow, but I think that's only because there's no way to do this in the UI. Other than that, this feels perfectly appropriate.
The current UI for editing custom properties has fallen behind their expanding functionality, but that's a separate issue.

For those not in the know, you can add a custom property referencing a text datablock (or any other datablock) with something like this in the PyConsole: `bpy.context.object['my_script'] = bpy.data.texts['rig_ui.py']` And I agree, it feels like a weird workflow, but I think that's only because there's no way to do this in the UI. Other than that, this feels perfectly appropriate. The current UI for editing custom properties has fallen behind their expanding functionality, but that's a separate issue.

Juan Pablo Bouza commented

2020-07-10 17:46:29 +02:00

Cool @Mets ! Yes, that's what I was imagining. So if you have this script referenced within a custom property, does it work when the character is linked?

As you are saying you have to create that property with python, I guess that you need a second script to create it, but once that script runs, does the "custom property script" work automatically in a linked file?

So if we had the text datablock custom property UI, would that solve all of our problems?

Cool @Mets ! Yes, that's what I was imagining. So if you have this script referenced within a custom property, does it work when the character is linked? As you are saying you have to create that property with python, I guess that you need a second script to create it, but once that script runs, does the "custom property script" work automatically in a linked file? So if we had the text datablock custom property UI, would that solve all of our problems?

Demeter Dzadik commented

2020-07-13 00:44:02 +02:00

Edited my previous comment to clarify. The line of code I posted is a perfectly valid line of code in current master. You can try it for yourself. The text datablock will come along with the rig when linking or appending, but it will not be executed until it is done so via the text editor or save and reload. The custom property editing UI is a separate, unrelated issue.

Germano Cavalcante commented

2020-07-17 15:44:18 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'

Demeter Dzadik commented

2021-05-25 18:16:32 +02:00

Added subscriber: @ZedDB

Demeter Dzadik commented

2021-05-25 18:16:32 +02:00

Want to drop a poke here because the nightmare has come true. I now have 8 animators asking me on a semi-daily basis why their rig UI is not showing up. I have made a canned reply and also added it to our animator on-boarding page, but ideally none of that would be necessary, if this idea could just get into master. ;)

This might be a good medium-prority and hopefully simple to implement studio feature request, so maybe a perfect candidate for @ZedDB? ❤️

Want to drop a poke here because the nightmare has come true. I now have 8 animators asking me on a semi-daily basis why their rig UI is not showing up. I have made a canned reply and also added it to our animator on-boarding page, but ideally none of that would be necessary, if this idea could just get into master. ;) This might be a good medium-prority and hopefully simple to implement studio feature request, so maybe a perfect candidate for @ZedDB? :heart:

Ben commented

2021-05-25 20:23:20 +02:00

Oh yes, please!
I have a canned response myself. The day I can delete the video telling animators to save and revert the file will be a happy one indeed!

Oh yes, please! I have a canned response myself. The day I can delete the video telling animators to save and revert the file will be a happy one indeed!

Eric Kaplin commented

2021-09-15 19:47:20 +02:00

Added subscriber: @ericEDFilms

Eric Kaplin commented

2021-09-15 19:47:20 +02:00

Please implement this, it really makes a lot of sense for rigs to come along with their own custom scripts.

Add the bpy.context.object['my_script'] = bpy.data.texts['rig_ui.py'] to the custom properties popup UI, so this is easy to reference a custom script
Linking a collection from a file runs all scripts that come along with the collection.

Boom, easy custom rig UI.

EDIT: Also just thought, some boilerplate code for what some simple rig UI script could look like would really seal the deal.

Please implement this, it really makes a lot of sense for rigs to come along with their own custom scripts. 1. Add the `bpy.context.object['my_script'] = bpy.data.texts['rig_ui.py']` to the custom properties popup UI, so this is easy to reference a custom script 2. Linking a collection from a file runs all scripts that come along with the collection. Boom, easy custom rig UI. EDIT: Also just thought, some boilerplate code for what some simple rig UI script could look like would really seal the deal.

Demeter Dzadik commented

2021-09-16 16:01:32 +02:00

I added a super basic example file with a rig that has a UI script attached, thanks for the suggestion.

Nils lerin commented

2022-11-03 11:16:49 +01:00

Added subscriber: @Nils-Lerin

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Running scripts on append/link #78794

Problem

Proposal