ok-script 2.0.19__tar.gz → 2.0.20__tar.gz

{ok_script-2.0.19 → ok_script-2.0.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ok-script
-Version: 2.0.19
+Version: 2.0.20
 Summary: Automation with Computer Vision for Python
 Author-email: ok-oldking <firedcto@gmail.com>
 License: ok-script License
@@ -212,6 +212,8 @@ python -m venv .venv
 - [白荆回廊](https://github.com/ok-oldking/ok-baijing)（停止维护）
 - [明日方舟：终末地](https://github.com/AliceJump/ok-end-field)
 - [异环](https://github.com/BnanZ0/ok-nte)
+- [棕色尘埃 2](https://github.com/GodRaymond233/ok-bd2)
+- [蓝色星原：旅谣](https://github.com/longer-sausage/OK-AzurPromilia)
 
 ## 社区与发布
 

{ok_script-2.0.19 → ok_script-2.0.20}/README.md

@@ -85,6 +85,8 @@ python -m venv .venv
 - [白荆回廊](https://github.com/ok-oldking/ok-baijing)（停止维护）
 - [明日方舟：终末地](https://github.com/AliceJump/ok-end-field)
 - [异环](https://github.com/BnanZ0/ok-nte)
+- [棕色尘埃 2](https://github.com/GodRaymond233/ok-bd2)
+- [蓝色星原：旅谣](https://github.com/longer-sausage/OK-AzurPromilia)
 
 ## 社区与发布
 

{ok_script-2.0.19 → ok_script-2.0.20}/ok/device/capture_methods/base.py

@@ -36,8 +36,8 @@ class BaseCaptureMethod:
         """Capture a frame.
 
         :param busy_wait: Seconds to wait when another caller owns the capture.
-            The default 0 returns None immediately, which suits polling loops
-            such as the task executor; one-off captures should wait instead.
+            The default 0 returns None immediately. The task executor waits
+            briefly; one-off captures should wait longer.
         """
         if self.exit_event.is_set():
             return

{ok_script-2.0.19 → ok_script-2.0.20}/ok/device/interaction_methods/keys.py

@@ -151,3 +151,33 @@ ADB_KEY_MAP = {
     'printscreen': 'KEYCODE_SYSRQ',
     'print_screen': 'KEYCODE_SYSRQ',
 }
+
+XBUTTON1 = 0x0001
+XBUTTON2 = 0x0002
+MOUSEEVENTF_XDOWN = 0x0080
+MOUSEEVENTF_XUP = 0x0100
+
+WM_XBUTTONDOWN = 0x020B
+WM_XBUTTONUP = 0x020C
+MK_XBUTTON1 = 0x0020
+MK_XBUTTON2 = 0x0040
+
+MOUSE_BUTTON_MAP = {
+    'mouse4': XBUTTON1,
+    'xbutton1': XBUTTON1,
+    'mouse5': XBUTTON2,
+    'xbutton2': XBUTTON2,
+}
+
+
+def is_mouse_button(key) -> bool:
+    if not isinstance(key, str):
+        return False
+    return key.strip().lower() in MOUSE_BUTTON_MAP
+
+
+def get_mouse_button(key) -> int:
+    if not isinstance(key, str):
+        return 0
+    return MOUSE_BUTTON_MAP.get(key.strip().lower(), 0)
+

{ok_script-2.0.19 → ok_script-2.0.20}/ok/device/interaction_methods/post_message.py

@@ -6,7 +6,10 @@ import win32gui
 
 from ok.device.capture_methods.base import BaseCaptureMethod
 from ok.device.interaction_methods.base import BaseInteraction
-from ok.device.interaction_methods.keys import vk_key_dict
+from ok.device.interaction_methods.keys import (
+    vk_key_dict, is_mouse_button, get_mouse_button,
+    XBUTTON1, MK_XBUTTON1, MK_XBUTTON2, WM_XBUTTONDOWN, WM_XBUTTONUP
+)
 from ok.util.logger import Logger
 
 logger = Logger.get_logger(__name__)
@@ -37,12 +40,27 @@ class PostMessageInteraction(BaseInteraction):
     def send_key_down(self, key, activate=True):
         if activate:
             self.try_activate()
+        if is_mouse_button(key):
+            btn = get_mouse_button(key)
+            mk = MK_XBUTTON1 if btn == XBUTTON1 else MK_XBUTTON2
+            wparam = win32api.MAKELONG(mk, btn)
+            pos = getattr(self, 'mouse_pos', (0, 0))
+            lparam = win32api.MAKELONG(int(pos[0]), int(pos[1]))
+            self.post(WM_XBUTTONDOWN, wparam, lparam)
+            return
         vk_code = self.get_key_by_str(key)
         lparam = self.make_lparam(vk_code, is_up=False)
         self.post(win32con.WM_KEYDOWN, vk_code, lparam)
 
     def send_key_up(self, key):
         # logger.debug(f'send_key_up {key}')
+        if is_mouse_button(key):
+            btn = get_mouse_button(key)
+            wparam = win32api.MAKELONG(0, btn)
+            pos = getattr(self, 'mouse_pos', (0, 0))
+            lparam = win32api.MAKELONG(int(pos[0]), int(pos[1]))
+            self.post(WM_XBUTTONUP, wparam, lparam)
+            return
         vk_code = self.get_key_by_str(key)
         lparam = self.make_lparam(vk_code, is_up=True)
         self.post(win32con.WM_KEYUP, vk_code, lparam)
@@ -215,6 +233,9 @@ class PostMessageInteraction(BaseInteraction):
             self._dynamic_target_hwnd = target_hwnd
 
             local_x, local_y = win32gui.ScreenToClient(target_hwnd, (abs_x, abs_y))
+            # Button messages must use the same target-client coordinates as
+            # the preceding move, including when a child window is selected.
+            self.mouse_pos = (local_x, local_y)
 
             hwnd_descriptions = []
             for index, hwnd_info in enumerate(hwnds):
@@ -233,7 +254,8 @@ class PostMessageInteraction(BaseInteraction):
         except Exception as e:
             logger.error(f'update_mouse_pos conversion error targeting {base_hwnd}', e)
             self._dynamic_target_hwnd = base_hwnd
-            return win32api.MAKELONG(int(x), int(y))
+            self.mouse_pos = (int(x), int(y))
+            return win32api.MAKELONG(*self.mouse_pos)
 
     def mouse_up(self, key="left"):
         if key == "left":

{ok_script-2.0.19 → ok_script-2.0.20}/ok/device/interaction_methods/pydirect.py

@@ -1,14 +1,19 @@
+import ctypes
 import time
 
 import pydirectinput
 
 from ok.device.capture_methods.base import BaseCaptureMethod
 from ok.device.interaction_methods.base import BaseInteraction
-from ok.device.interaction_methods.keys import normalize_pydirect_key
+from ok.device.interaction_methods.keys import (
+    normalize_pydirect_key, is_mouse_button, get_mouse_button,
+    MOUSEEVENTF_XDOWN, MOUSEEVENTF_XUP
+)
 from ok.util.logger import Logger
 from ok.util.process import is_admin
 
 logger = Logger.get_logger(__name__)
+user32 = ctypes.windll.user32
 
 class PyDirectInteraction(BaseInteraction):
 
@@ -35,6 +40,12 @@ class PyDirectInteraction(BaseInteraction):
         if not self.clickable():
             logger.error(f"can't click on {key}, because capture is not clickable")
             return
+        if is_mouse_button(key):
+            btn = get_mouse_button(key)
+            user32.mouse_event(MOUSEEVENTF_XDOWN, 0, 0, btn, 0)
+            time.sleep(down_time)
+            user32.mouse_event(MOUSEEVENTF_XUP, 0, 0, btn, 0)
+            return
         key = normalize_pydirect_key(key)
         pydirectinput.keyDown(key)
         time.sleep(down_time)
@@ -44,8 +55,22 @@ class PyDirectInteraction(BaseInteraction):
         if not self.clickable():
             logger.error(f"can't click on {key}, because capture is not clickable")
             return
+        if is_mouse_button(key):
+            btn = get_mouse_button(key)
+            user32.mouse_event(MOUSEEVENTF_XDOWN, 0, 0, btn, 0)
+            return
         pydirectinput.keyDown(normalize_pydirect_key(key))
 
+    def send_key_up(self, key):
+        if not self.clickable():
+            logger.error(f"can't click on {key}, because capture is not clickable")
+            return
+        if is_mouse_button(key):
+            btn = get_mouse_button(key)
+            user32.mouse_event(MOUSEEVENTF_XUP, 0, 0, btn, 0)
+            return
+        pydirectinput.keyUp(normalize_pydirect_key(key))
+
     def scroll(self, x, y, scroll_amount):
         import mouse
         if scroll_amount < 0:
@@ -62,12 +87,6 @@ class PyDirectInteraction(BaseInteraction):
             time.sleep(0.001)
         time.sleep(0.02)
 
-    def send_key_up(self, key):
-        if not self.clickable():
-            logger.error(f"can't click on {key}, because capture is not clickable")
-            return
-        pydirectinput.keyUp(normalize_pydirect_key(key))
-
     def move(self, x, y):
         import mouse
         if not self.clickable():

{ok_script-2.0.19 → ok_script-2.0.20}/ok/device/interaction_methods/pynput.py

@@ -2,6 +2,7 @@ import time
 
 from ok.device.capture_methods.base import BaseCaptureMethod
 from ok.device.interaction_methods.base import BaseInteraction
+from ok.device.interaction_methods.keys import is_mouse_button, get_mouse_button, XBUTTON1
 from ok.util.logger import Logger
 from ok.util.process import is_admin
 
@@ -53,36 +54,37 @@ class PynputInteraction(BaseInteraction):
         except KeyError:
             return key
 
-    def send_key(self, key, down_time=0.01):
+    def _key_controller(self, key):
+        if is_mouse_button(key):
+            from pynput import mouse
+            return mouse.Controller(), self.get_mouse_button(key)
         from pynput import keyboard
+        return keyboard.Controller(), self._parse_key(str(key))
+
+    def send_key(self, key, down_time=0.01):
         if not self.clickable():
             logger.error(f"can't click on {key}, because capture is not clickable")
             return
 
-        controller = keyboard.Controller()
-        parsed_key = self._parse_key(str(key))
+        controller, parsed_key = self._key_controller(key)
         controller.press(parsed_key)
         time.sleep(down_time)
         controller.release(parsed_key)
 
     def send_key_down(self, key):
-        from pynput import keyboard
         if not self.clickable():
             logger.error(f"can't click on {key}, because capture is not clickable")
             return
 
-        controller = keyboard.Controller()
-        parsed_key = self._parse_key(str(key))
+        controller, parsed_key = self._key_controller(key)
         controller.press(parsed_key)
 
     def send_key_up(self, key):
-        from pynput import keyboard
         if not self.clickable():
             logger.error(f"can't click on {key}, because capture is not clickable")
             return
 
-        controller = keyboard.Controller()
-        parsed_key = self._parse_key(str(key))
+        controller, parsed_key = self._key_controller(key)
         controller.release(parsed_key)
 
     def scroll(self, x, y, scroll_amount):
@@ -184,6 +186,8 @@ class PynputInteraction(BaseInteraction):
 
     def get_mouse_button(self, key):
         from pynput import mouse
+        if is_mouse_button(key):
+            return mouse.Button.x1 if get_mouse_button(key) == XBUTTON1 else mouse.Button.x2
         if key == "right":
             return mouse.Button.right
         if key == "middle":

{ok_script-2.0.19 → ok_script-2.0.20}/ok/task/TaskExecutor.py

@@ -15,6 +15,9 @@ from ok.util.window import ratio_text_to_number
 
 logger = Logger.get_logger(__name__)
 
+# How long next_frame() waits for another caller to finish its capture request.
+NEXT_FRAME_BUSY_WAIT = 0.1
+
 
 class ExecutorJob:
     """A callable that runs once on the executor thread, outside the task queue.
@@ -321,7 +324,13 @@ class TaskExecutor:
             if time_out is not None and time.time() - start >= time_out:
                 return None
             if self.can_capture():
-                frame = self.method.get_frame()
+                # A one-off capture on another thread (debug screenshot,
+                # template capture) owns the request for about one frame.
+                # Waiting for it is far cheaper than the retry sleep below.
+                busy_wait = NEXT_FRAME_BUSY_WAIT
+                if time_out is not None:
+                    busy_wait = min(busy_wait, max(0, time_out - (time.time() - start)))
+                frame = self.method.get_frame(busy_wait=busy_wait)
                 if frame is not None:
                     height, width = frame.shape[:2]
                     if height <= 0 or width <= 0:

{ok_script-2.0.19 → ok_script-2.0.20}/ok/task/task.py

@@ -29,7 +29,8 @@ VALID_NAMED_KEYS = {
     'caps_lock', 'num_lock', 'scroll_lock', 'print_screen',
     'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', 'f11', 'f12',
     'num0', 'num1', 'num2', 'num3', 'num4', 'num5', 'num6', 'num7', 'num8', 'num9',
-    'windows', 'win', 'command', 'cmd', 'cmd_l', 'cmd_r', 'meta'
+    'windows', 'win', 'command', 'cmd', 'cmd_l', 'cmd_r', 'meta',
+    'mouse4', 'mouse5', 'xbutton1', 'xbutton2'
 }
 
 logger = Logger.get_logger(__name__)

{ok_script-2.0.19 → ok_script-2.0.20}/ok/test/__init__.py

@@ -12,7 +12,10 @@ def init_ok(config):
         config['debug'] = True
         config['analytics'] = None
         config['check_mutex'] = False
-        print(f'OKTestRunner init_ok config: {config}')
+        try:
+            print(f'OKTestRunner init_ok config: {config}')
+        except UnicodeEncodeError:
+            print(f'OKTestRunner init_ok config: {str(config).encode("ascii", errors="replace").decode("ascii")}')
         ok = OK(config)
         ok.task_executor.debug_mode = True
         ok.device_manager.capture_method = ImageCaptureMethod(

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/about/AboutTab.py

@@ -66,6 +66,8 @@ class AboutTab(Tab):
             {"name": self.tr("Onmyoji"), "url": "https://github.com/YunLiuZ/ok-Onmyoji", "website": "https://ok-script.com/ok-onmyoji/"},
             {"name": self.tr("Arknights: Endfield"), "url": "https://github.com/AliceJump/ok-end-field", "website": "https://ok-script.com/ok-end-field/"},
             {"name": self.tr("Neverness to Everness"), "url": "https://github.com/BnanZ0/ok-neverness-to-everness", "website": "https://ok-script.com/ok-nte/"},
+            {"name": self.tr("BrownDust II"), "url": "https://github.com/GodRaymond233/ok-bd2"},
+            {"name": self.tr("Azur Promilia"), "url": "https://github.com/longer-sausage/OK-AzurPromilia"},
         ]
 
         def normalize_url(url):

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/en_US.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>Disclaimer</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>BrownDust II</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>Azur Promilia</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/es_ES.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>Aviso legal</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>BrownDust II</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>Azur Promilia</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/ja_JP.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>免責事項</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>ブラウンダスト2</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>アズールプロミリア</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>
@@ -3284,4 +3292,4 @@
             <translation>いいえ</translation>
         </message>
     </context>
-</TS>
+</TS>

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/ko_KR.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>면책 조항</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>브라운더스트2</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>아주르 프로밀리아</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>
@@ -3293,4 +3301,4 @@
             <translation>아니요</translation>
         </message>
     </context>
-</TS>
+</TS>

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/zh_CN.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>免责声明</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>棕色尘埃 2</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>蓝色星原：旅谣</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>

{ok_script-2.0.19 → ok_script-2.0.20}/ok/ui/qt/i18n/zh_TW.ts

@@ -93,6 +93,14 @@
             <source>Disclaimer</source>
             <translation>免責聲明</translation>
         </message>
+        <message>
+            <source>BrownDust II</source>
+            <translation>棕色塵埃 2</translation>
+        </message>
+        <message>
+            <source>Azur Promilia</source>
+            <translation>藍色星原：旅謠</translation>
+        </message>
     </context>
     <context>
         <name>ActWindow</name>