Add debug notes

Author: upgradeQ

README.md

@@ -1,5 +1,7 @@
 # OBS Studio Python Scripting Cheatsheet
-`obspython` OBS Studio API.Obs scripts examples in /src. Each obs script example mostly will operate on *existsing* `TEXT SOURCE`
+- `obspython` OBS Studio API.Obs scripts examples in `/src` 
+- Each obs script example mostly will operate on *existsing* text source
+- It is possible to duplicate scripts and re-add them to OBS ( names must be different) 
 # Table of content 
 - [Using classes](#using-classes)
 - [with statement](#with-statement)
@@ -18,6 +20,7 @@
 - [Timing (sequential primitives) ](#timing-sequential-primitives)
 - [Hotkey](#hotkey)
 - [Links](#links)
+- [Debug](#debug)
 - [Contribute](#contribute)
 
 ## Using classes 
@@ -324,10 +327,24 @@ def script_save(settings):
 ```
 - [Full example](src/obs_httkeys.py) 
 - [Example with global ](src/hotkey_exmpl.py)
+
+# Debug
+There is no stdin therefore you can't use pdb , options are:
+- using `print`
+- using pycharm remote debugging (localhost)
+- using [vscode](https://code.visualstudio.com/docs/python/debugging) attach to the process:
+    - Load python extension
+    - open script file , `pip install debugpy` , place  `debugpy.breakpoint()` somewhere
+        - Run (F5) select configuration ( Attach using Process ID)
+        - select obs (on windows `obs64.exe`)
+        - View  select Debug Console (ctrl+shift+y) 
+- [Example debugpy obs ](src/debug_exmpl.py)
+
+![screenshot](src/debug.png)  
+
 # Links
 - [Scripts](https://obsproject.com/forum/resources/categories/scripts.5/)
 - [Repo](https://github.com/obsproject/obs-studio)
 - [Docs](https://obsproject.com/docs/) , [Docs/scripting](https://obsproject.com/docs/scripting.html) , [Docs index](https://obsproject.com/docs/genindex.html)
 # Contribute
-[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)
+Contributions are welcome!

src/debug.png

@@ -0,0 +1,72 @@
+import obspython as obs
+import debugpy
+
+
+class Hotkey:
+    def __init__(self, callback, obs_settings, _id):
+        self.obs_data = obs_settings
+        self.hotkey_id = obs.OBS_INVALID_HOTKEY_ID
+        self.hotkey_saved_key = None
+        self.callback = callback
+        self._id = _id
+
+        self.load_hotkey()
+        self.register_hotkey()
+        self.save_hotkey()
+
+    def register_hotkey(self):
+        description = "Htk " + str(self._id)
+        self.hotkey_id = obs.obs_hotkey_register_frontend(
+            "htk_id" + str(self._id), description, self.callback
+        )
+        obs.obs_hotkey_load(self.hotkey_id, self.hotkey_saved_key)
+
+    def load_hotkey(self):
+        self.hotkey_saved_key = obs.obs_data_get_array(
+            self.obs_data, "htk_id" + str(self._id)
+        )
+        obs.obs_data_array_release(self.hotkey_saved_key)
+
+    def save_hotkey(self):
+        self.hotkey_saved_key = obs.obs_hotkey_save(self.hotkey_id)
+        obs.obs_data_set_array(
+            self.obs_data, "htk_id" + str(self._id), self.hotkey_saved_key
+        )
+        obs.obs_data_array_release(self.hotkey_saved_key)
+
+
+class h:
+    htk_copy = None  # this attribute will hold instance of Hotkey
+
+
+def cb1(pressed):
+    debugpy.breakpoint()
+    if pressed:
+        print("callback1: " + e1.txt)
+
+
+class e:
+    txt = "default txt"
+
+
+e1 = e()
+h1 = h()
+
+
+def script_properties():
+    props = obs.obs_properties_create()
+    obs.obs_properties_add_text(props, "_text1", "_text1:", obs.OBS_TEXT_DEFAULT)
+    return props
+
+
+def script_update(settings):
+    _text1 = obs.obs_data_get_string(settings, "_text1")
+    e1.txt = _text1
+
+
+def script_load(settings):
+    h1.htk_copy = Hotkey(cb1, settings, "h1_id")
+
+
+def script_save(settings):
+    h1.htk_copy.save_hotkey()