0.5.0 new effect and readme update

Author: upgradeQ

README.md

@@ -7,9 +7,10 @@ _Optionally create media source_
 - Open `Tools>Scripts`
 - select this script 
 - set settings for it, change duration and refresh rate
-- preview it if need,
+- preview it if needed,
+- reset if needed,
 - set hotkey in `File>Settings`
-# Current implemented text effects
+# Example text effects
 - static 
 > just show text  
 > cycle threw colors   
@@ -18,10 +19,18 @@ _Optionally create media source_
 - ![preview](https://i.imgur.com/2M2wDUD.gif)   
 > loading text  
 - ![preview](https://i.imgur.com/H0pgtHf.gif)   
-> tremor effect NEW    
+> tremor effect     
 - ![preview](https://i.imgur.com/8G3TVGp.gif)   
-> sanic effect NEW   
-- ![preview](https://i.imgur.com/pvaEWlE.gif)   
+> sanic effect    
+- ![preview](https://i.imgur.com/pvaEWlE.gif)
+# How it works
+ There is two classes:
+ - `TextContent` - updates text 
+ - `Driver` - interacts with obs properties and controls execution
+
+ Interaction with obs happens on instance of `Driver` - *scripted_text_driver* it will update source name, scirpted text, selected effect and more according to settings from UI. Hotkey handling via `script_save` and `script_load` with callback on *scripted_text_driver* `hotkey_hook`. Note this callback is also attached to `PREVIEW` button in settings. It will trigger `obs_timer` , set `lock` to `False` (to run single callback at time).  `obs_timer` will execute `ticker` with `interval` aka `refresh_rate`. `ticker` will execute selected text effect from settings ,substract `refresh_rate` from `duration` , check if its <= 0,then reset everything to initial state,remove itself via `obs.remove_current_callback`. 
+ To create a text effect , this naming `someefect_effect` is required and also adding it to `effects_list` in `load`. Text effects use inherited method  `update_text` to update text one tick at time. 
+
 # 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)

scripted_text.py

@@ -7,7 +7,7 @@
 from random import seed
 
 __author__ = "upgradeQ"
-__version__ = "0.4.0"
+__version__ = "0.5.0"
 HOTKEY_ID = obs.OBS_INVALID_HOTKEY_ID
 
 # auto release context managers
@@ -55,6 +55,13 @@ def __init__(self, text_string="This is default text", source_name=None):
         self.source_name = source_name
         self.text_string = text_string
         self.location = (0, 0)
+        self._text_chars = self._wpm_chars = []
+        self.rand_index = self.lst_index = self.wpm_index = 0
+        self.position_swap = cycle([True, False])
+        self.last_jump_x = self.last_jump_y = 0
+        self.blinking = cycle([True, False])
+        self.palette = cycle([0xFFBE0B, 0xFB5607, 0xFF006E, 0x8338EC, 0x3A86FF])
+        self.dots = cycle([" ", ".", "..", "..."])
 
     def update_text(self, scripted_text, color=None):
         """takes scripted_text , sets its value in obs  """
@@ -79,19 +86,9 @@ def __init__(self, text_string, source_name):
         self.duration = 5 * 1000
         self.effect_duration = 3 * 1000
 
-        self._text_chars = []
-        self.rand_index = 0
-        self.lst_index = 0
-        self.blinking_bar = cycle([True, False])
-        self.position_swap = cycle([True, False])
-        self.last_jump_x = self.last_jump_y = 0
-        self.blinking = cycle([True, False])
-        self.palette = cycle([0xFFBE0B, 0xFB5607, 0xFF006E, 0x8338EC, 0x3A86FF])
-        self.dots = cycle([" ", ".", "..", "..."])
-
     def load(self):
         mapping = dict()
-        for i in [
+        effects_list = [
             "rainbow",
             "static",
             "blink",
@@ -100,7 +97,9 @@ def load(self):
             "sanic",
             "typewriter",
             "scrmbl",
-        ]:
+            "fastread",
+        ]
+        for i in effects_list:
             mapping[i] = getattr(self, i + "_" + "effect")
         return mapping
 
@@ -122,8 +121,7 @@ def check_duration():
                 self.duration = 5 * 1000
                 self.lock = True
                 self.last_jump_y, self.last_jump_x = 0, 0
-                self.lst_index = 0
-                self.rand_index = 0
+                self.lst_index = self.rand_index = self.wpm_index = 0
 
         try:
             self.txt_efcts[text_effect]()
@@ -233,7 +231,6 @@ def sanic_effect(self):
             with data_ar(scroll) as filter_settings:
                 obs.obs_data_set_int(filter_settings, "speed_x", 5000)
                 obs.obs_source_update(scroll, filter_settings)
-                # set to zero scrolling speed and it will not interfere with others effects
                 if self.duration // self.refresh_rate <= 3:
                     obs.obs_source_filter_remove(source, scroll)
                     self.duration = 0
@@ -243,20 +240,18 @@ def typewriter_effect(self):
         l = len(self.scripted_text)
         result = self.scripted_text[: self.lst_index]
         space_count = l - len(result)
-        bar = "_" if next(self.blinking_bar) else ""
-        result += bar
         result += space_count * " "
         self.lst_index += 1
         self.update_text(result)
 
     def scrmbl_effect(self):
-        """tweak refresh rate & duration """
+        """adjust refresh rate in settings"""
         try:
+            self._text_chars = list(self.text_chars(self.scripted_text))
             self.update_text(self._text_chars[self.rand_index])
             self.rand_index += 1
         except IndexError:
             self.update_text(self.scripted_text)
-            # self.rand_index = 0
 
     def text_chars(self, scripted_str):
         """inspired by https://github.com/etienne-napoleone/scrmbl """
@@ -280,6 +275,20 @@ def gen(scripted_str, iterations):
 
         return gen(scripted_str, 3)
 
+    def fastread_effect(self):
+        """show one word at time centered with spaces"""
+        try:
+            self._wpm_chars = self.wpm_chars()
+            self.update_text(self._wpm_chars[self.wpm_index])
+            self.wpm_index += 1
+        except IndexError:
+            self.update_text("")
+
+    def wpm_chars(self):
+        s = self.scripted_text.split(" ")
+        m = len(max(s, key=len))
+        return [i.center(m, " ") for i in s]
+
     def hotkey_hook(self):
         """ trigger hotkey event"""
         self.play_sound()
@@ -291,14 +300,17 @@ def hotkey_hook(self):
             obs.timer_add(self.ticker, interval)
         self.lock = False
 
+    def reset_duration(self):
+        self.duration = 0
+
 
 scripted_text_driver = Driver(
     text_string="default string", source_name="default source name"
 )
 
 
 def script_description():
-    return " Scripted text \n with effects and media "
+    return " Scripted text \n with effects and media ".upper()
 
 
 def script_defaults(settings):
@@ -321,14 +333,10 @@ def script_update(settings):
         settings, "playsound"
     )
     scripted_text_driver.effect = obs.obs_data_get_string(settings, "text_effect")
-    scripted_text_driver._text_chars = list(
-        scripted_text_driver.text_chars(scripted_text_driver.scripted_text)
-    )
     scripted_text_driver.stop_sound()
 
 
 def script_properties():
-    "https://obsproject.com/docs/reference-properties.html"
     props = obs.obs_properties_create()
 
     obs.obs_properties_add_text(
@@ -380,7 +388,11 @@ def script_properties():
         obs.source_list_release(sources)
 
     obs.obs_properties_add_button(
-        props, "button1", "preview", lambda *props: scripted_text_driver.hotkey_hook()
+        props, "button1", "PREVIEW", lambda *props: scripted_text_driver.hotkey_hook()
+    )
+
+    obs.obs_properties_add_button(
+        props, "button2", "RESET", lambda *props: scripted_text_driver.reset_duration()
     )
 
     return props