Screencast Key Status Add-on #76611

New Issue

nutti · 2020-05-10T10:56:17+02:00

nutti commented

2020-05-10 10:56:17 +02:00

Screencast Keys add-on is an add-on which displays the key & mouse event.
I think many people know about this add-on and removed from official repository due to lots of issues as mentioned below.
https://developer.blender.org/T51419

I have worked on this add-on since Blender 2.8 was released.
https://github.com/nutti/Screencast-Keys

In the process to port this add-on to Blender 2.8, I rewrote whole of codes and fixed the bugs mentioned there.
Also, lots of people used & tested this add-on, which makes this add-on improved in functionality and user interface.
https://github.com/nutti/Screencast-Keys/issues?q=is%3Aissue+is%3Aclosed

Many people still uses add-on to make tutorial, but some people confusing about the versions which they should use because of removal of this add-on in past.
Therefore, I think it is a good idea to return to official repository to provide the newest & bug fixed version.

I will maintain this add-on in the future, so the lack of maintainer will not be matter.

What do you think about this idea?

Thanks!

Screencast Keys add-on is an add-on which displays the key & mouse event. I think many people know about this add-on and removed from official repository due to lots of issues as mentioned below. https://developer.blender.org/T51419 I have worked on this add-on since Blender 2.8 was released. https://github.com/nutti/Screencast-Keys In the process to port this add-on to Blender 2.8, I rewrote whole of codes and fixed the bugs mentioned there. Also, lots of people used & tested this add-on, which makes this add-on improved in functionality and user interface. https://github.com/nutti/Screencast-Keys/issues?q=is%3Aissue+is%3Aclosed Many people still uses add-on to make tutorial, but some people confusing about the versions which they should use because of removal of this add-on in past. Therefore, I think it is a good idea to return to official repository to provide the newest & bug fixed version. I will maintain this add-on in the future, so the lack of maintainer will not be matter. What do you think about this idea? Thanks!

Brendon Murphy was assigned by nutti

2020-05-10 10:56:17 +02:00

nutti commented

2020-05-10 10:56:17 +02:00

Added subscriber: @nutti

Ankit Meel commented

2020-05-10 13:54:10 +02:00

Added subscriber: @ankitm

Ankit Meel commented

2020-05-10 13:54:10 +02:00

Hi!
Have you seen https://wiki.blender.org/wiki/Process/Addons ?

Hi! Have you seen https://wiki.blender.org/wiki/Process/Addons ?

nutti commented

2020-05-10 14:22:17 +02:00

@ankitm

Sure.
Before moving on code review, I would like to discuss the plan about Screencast Keys add-on itself.
Or, is it possible to create diffs directly?
If yes, I will cleanup the add-on's code and make code review request.

Thanks for your concern!

@ankitm Sure. Before moving on code review, I would like to discuss the plan about Screencast Keys add-on itself. Or, is it possible to create diffs directly? If yes, I will cleanup the add-on's code and make code review request. Thanks for your concern!

Brendon Murphy commented

2020-05-11 00:44:46 +02:00

hi @nutti, I have no problem with this being added back. I've been following your progress for some time now.
Given the importance of this addon and it's worth looking at.

hi @nutti, I have no problem with this being added back. I've been following your progress for some time now. Given the importance of this addon and it's worth looking at.

Brendon Murphy commented

2020-05-11 00:57:13 +02:00

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

Brendon Murphy commented

2020-05-11 00:57:13 +02:00

Added subscriber: @ideasman42

Brendon Murphy commented

2020-05-11 00:57:13 +02:00

@ideasman42 hi, I would like to target this for 2.84 bcon1. @nutti has maintained and fixed this addon over many releases and solved the issues that caused it's initial removal.
Thanks.

@ideasman42 hi, I would like to target this for 2.84 bcon1. @nutti has maintained and fixed this addon over many releases and solved the issues that caused it's initial removal. Thanks.

Campbell Barton commented

2020-05-11 04:24:31 +02:00

Personally, I'd rather not support this. As long as it's constrained to a single area this gives less useful results than equivalent tools that run on the operating system.

Besides this, the add-on depends on referencing Blender's internal event handlers which is fragile and will break as we make changes to Blender it's self.

https://github.com/nutti/Screencast-Keys/tree/master/src/screencast_keys/utils/c_structures

This needs to be removed if the add-on is considered for inclusion with Blender.

If this is supported, it could be written as part of Blender as run at the window level, not per area. Either the Python API would need to support this without hacking into our C structures, or it could be written as part of Blender without using the Python API.

Personally, I'd rather not support this. As long as it's constrained to a single area this gives less useful results than equivalent tools that run on the operating system. Besides this, the add-on depends on referencing Blender's internal event handlers which is fragile and will break as we make changes to Blender it's self. https://github.com/nutti/Screencast-Keys/tree/master/src/screencast_keys/utils/c_structures This needs to be removed if the add-on is considered for inclusion with Blender. ---- If this is supported, it could be written as part of Blender as run at the window level, not per area. Either the Python API would need to support this without hacking into our C structures, or it could be written as part of Blender without using the Python API.

nutti commented

2020-05-11 14:12:34 +02:00

Thanks for your comments.

As long as it's constrained to a single area this gives less useful results than equivalent tools that run on the operating system.

I think this limitation can be came over by using 'Set Origin' operation and 'origin' option in this add-on.
Also, there is an option which runs at window level.

Besides this, the add-on depends on referencing Blender's internal event handlers which is fragile and will break as we make changes to Blender it's self.

I agree with this.
However, I could not query events only in current Python APIs.
Is there any possibility to add Python APIs which queries all events in queues on wmWindow struct in future?
If so, I could implement this add-on without any hackings to C structures.

Thanks for your comments. > As long as it's constrained to a single area this gives less useful results than equivalent tools that run on the operating system. I think this limitation can be came over by using 'Set Origin' operation and 'origin' option in this add-on. Also, there is an option which runs at window level. > Besides this, the add-on depends on referencing Blender's internal event handlers which is fragile and will break as we make changes to Blender it's self. I agree with this. However, I could not query events only in current Python APIs. Is there any possibility to add Python APIs which queries all events in queues on wmWindow struct in future? If so, I could implement this add-on without any hackings to C structures.

Campbell Barton commented

2020-05-12 05:37:56 +02:00

Adding API calls is possible, although the API calls are likely to be so spesific to this add-on that we might just as well add the feature to Blender it's self.

If we have to maintain special API's for this feature in Blender, this brings us back to the question of this functionality being something worth investing development time in.

Closing this task since this is more a design topic (including screen-cast key status functionality).

Added design task for this blender/blender#76666 (Inclusion of Screen-cast Key Status Functionality)

Adding API calls is possible, although the API calls are likely to be so spesific to this add-on that we might just as well add the feature to Blender it's self. If we have to maintain special API's for this feature in Blender, this brings us back to the question of this functionality being something worth investing development time in. ---- Closing this task since this is more a design topic (including screen-cast key status functionality). Added design task for this blender/blender#76666 (Inclusion of Screen-cast Key Status Functionality)

Campbell Barton commented

2020-05-12 05:38:16 +02:00

Changed status from 'Confirmed' to: 'Archived'

Campbell Barton closed this issue

2020-05-12 05:38:16 +02:00

nutti commented

2020-05-12 09:23:07 +02:00

I left some comments on new task.
Thanks for considering this topic!

I left some comments on new task. Thanks for considering this topic!

Sign in to join this conversation.