Add hotkey, remove stale code, update Readme

Author: upgradeQ

README.md

@@ -11,6 +11,9 @@ Using [`obs_sceneitem_set_pos`](https://obsproject.com/docs/reference-scenes.htm
 # Usage
 - Create a _source_ with desired cursor(e.g Image source or Media source).
 - In scripts select _that_ source name.
+- To center source (scene item ) go to:  Transform > Edit Transform > Positional Alignment > Center
+
+## Advanced usage
 - Make a group, add Display Capture, Window Capture.
 
 ![img](https://i.imgur.com/CHuLwmp.png)
@@ -34,7 +37,7 @@ Using [`obs_sceneitem_set_pos`](https://obsproject.com/docs/reference-scenes.htm
 > Have you ever needed to zoom in on your screen to show some fine detail work,
 > or to make your large 4k/ultrawide monitor less daunting?
 > Zoom and Follow for OBS Studio does exactly that, zooms in on your mouse and follows it around.
-> Configurable and low-impact, you can now do old school Camtasia zoom ins live
+> Configurable and low-impact, you can now do old school zoom ins live
 
 See: [Zoom and Follow](https://obsproject.com/forum/resources/zoom-and-follow.1051/) , [source code ](https://github.com/tryptech/obs-zoom-and-follow)
 
@@ -48,14 +51,25 @@ They all have some level of transparency.
 ![Imgur](https://i.imgur.com/s3jvZP5.png) 
 
 # On the Roadmap
-- Visual indicator of mouse up/down state.
 - Lua based shaders rendering (on mouse up, down, trail, etc...)
-- Custom web page rendering (on mouse up, down, trail, etc...)
+- Custom web pages 
+- Visual indicator of mouse up/down state.
 
 # Acknowledgments
 - [`3_4_700`](https://github.com/34700) added offsets functionality for precise custom cursor(like a hand drawn arm holding a pen for artists)
 - [`tholman/cursor-effects`](https://github.com/tholman/cursor-effects) - stock cursor trails
 
 # Contribute
+You are welcome to contribute. Help is needed.
+## Developing
+There are roadmap items to choose, you are also free to suggest ideas to add and implement. There are forums and GitHub Issues check them out for suggestions or bug reports.
  [Forks](https://help.github.com/articles/fork-a-repo) are a great way to contribute to a repository.
 After forking a repository, you can send the original author a [pull request](https://help.github.com/articles/using-pull-requests)
+## Marketing 
+Write articles, reviews or tell your friends about it. The more users we have, the more people we have testing and the better we can become.
+## Design 
+Come up with some new good skins or interactive web skins, and add them.
+## Voting
+In order to improve this scripting functionality and integrate it into OBS Studio, you are encouraged to vote for this feature:
+https://ideas.obsproject.com/posts/71/option-to-highlight-mouse-cursor-and-mouse-clicks
+Currently the program lacks a way to get the position of the cursor in the texture and is not available in the OBS Studio shader language. 

mouse_skin_obs.py

@@ -1,9 +1,11 @@
 import obspython as S  # studio
 from contextlib import contextmanager, ExitStack
-from types import SimpleNamespace as dot
-from pynput.mouse import Controller  # python -m pip install pynput
+from itertools import cycle
+from pynput.mouse import (
+    Controller,
+)  # There mighbt be an import error try run this command: python -m pip install pynput
 
-__version__ = "2.1.1"
+__version__ = "2.2.0"
 c = Controller()
 get_position = lambda: c.position
 
@@ -88,49 +90,52 @@ def send_mouse_move_to_browser(
     S.obs_source_send_mouse_move(source, event, False)  # do not leave
 
 
-G = dot()
+def apply_scale(x, y, width, height):
+    width = round(width * x)
+    height = round(height * y)
+    return width, height
 
-G.LMB = G.RMB = G.MOUSE_HOOKED = False
-# Not yet implemented functionality for mouse up/down events
 
+def lerp(minVal, maxVal, k):
+    val = minVal + ((maxVal - minVal) * k)
+    return val
 
-def HTK_1_CB(pressed):
-    G.LMB = pressed
 
+class Hotkey:
+    def __init__(self, callback, obs_settings, _id):
+        self.obs_data = obs_settings
+        self.hotkey_id = S.OBS_INVALID_HOTKEY_ID
+        self.hotkey_saved_key = None
+        self.callback = callback
+        self._id = _id
 
-def HTK_2_CB(pressed):
-    G.RMB = pressed
+        self.load_hotkey()
+        self.register_hotkey()
+        self.save_hotkey()
 
+    def register_hotkey(self):
+        description = "Htk " + str(self._id)
+        self.hotkey_id = S.obs_hotkey_register_frontend(
+            "htk_id" + str(self._id), description, self.callback
+        )
+        S.obs_hotkey_load(self.hotkey_id, self.hotkey_saved_key)
 
-def hook_mouse_buttons():
-    if G.MOUSE_HOOKED:
-        raise RuntimeError("already hooked mouse")
-    key_1 = '{"htk_1_mouse": [ { "key": "OBS_KEY_MOUSE1" } ], '
-    key_2 = '"htk_2_mouse": [ { "key": "OBS_KEY_MOUSE2" } ]}'
-    json_s = key_1 + key_2
-    default_hotkeys = [
-        dot(id="htk_1_mouse", des="LMB state", callback=HTK_1_CB),
-        dot(id="htk_2_mouse", des="RMB state", callback=HTK_2_CB),
-    ]
-    settings = S.obs_data_create_from_json(json_s)
-    for k in default_hotkeys:
-        a = S.obs_data_get_array(settings, k.id)
-        h = S.obs_hotkey_register_frontend(k.id, k.des, k.callback)
-        S.obs_hotkey_load(h, a)
-        S.obs_data_array_release(a)
-    S.obs_data_release(settings)
-    G.MOUSE_HOOKED = True
+    def load_hotkey(self):
+        self.hotkey_saved_key = S.obs_data_get_array(
+            self.obs_data, "htk_id" + str(self._id)
+        )
+        S.obs_data_array_release(self.hotkey_saved_key)
 
+    def save_hotkey(self):
+        self.hotkey_saved_key = S.obs_hotkey_save(self.hotkey_id)
+        S.obs_data_set_array(
+            self.obs_data, "htk_id" + str(self._id), self.hotkey_saved_key
+        )
+        S.obs_data_array_release(self.hotkey_saved_key)
 
-def apply_scale(x, y, width, height):
-    width = round(width * x)
-    height = round(height * y)
-    return width, height
 
-
-def lerp(minVal, maxVal, k):
-    val = minVal + ((maxVal - minVal) * k)
-    return val
+class HotkeyDataHolder:
+    htk_copy = None  # this attribute will hold instance of Hotkey
 
 
 class CursorAsSource:
@@ -228,8 +233,9 @@ def ticker(self):  # it is not a thread because obs might not close properly
             S.remove_current_callback()
 
 
+HOTKEY_DATA_HOLDER = HotkeyDataHolder()
 PY_CURSOR = CursorAsSource()
-hook_mouse_buttons()
+HOTKEY_TOGGLE_ITERATOR = cycle([True, False])
 ###############               ###############               ###############
 
 
@@ -245,6 +251,25 @@ def start_pressed(props, prop):
     PY_CURSOR.flag = False  # to keep only one timer callback
 
 
+def callback_on_off(pressed):
+    if pressed:
+        a = b = "undefined"
+        if next(HOTKEY_TOGGLE_ITERATOR):
+            start_pressed(a, b)
+        else:
+            stop_pressed(a, b)
+
+
+def script_load(settings):
+    HOTKEY_DATA_HOLDER.htk_copy = Hotkey(
+        callback_on_off, settings, "On/Off cursor skin"
+    )
+
+
+def script_save(settings):
+    HOTKEY_DATA_HOLDER.htk_copy.save_hotkey()
+
+
 def react_property(props, prop, settings):
     p = S.obs_properties_get(props, "target")
     p2 = S.obs_properties_get(props, "browser")
@@ -347,9 +372,11 @@ def script_properties():
 <h3 style="color:orange">Authors</h3>
 <a href="https://github.com/upgradeQ"> upgradeQ </a> <br>
 <a href="https://github.com/3_4_700"> 34700 </a>
-""".format(**locals())
+""".format(
+    **locals()
+)
 
 
 def script_description():
-    print(description,"Released under MIT license")
+    print(description, "Released under MIT license")
     return description