Support LiveSplit integration with start and reset image

Author: Avasam

README.md

@@ -1,4 +1,4 @@
-# <img src="https://raw.githubusercontent.com/Avasam/Auto-Split/main/res/icon.ico" alt="LiveSplit" height="42" width="45" align="top"/> AutoSplit
+# <img src="https://raw.githubusercontent.com/TouFool/Auto-Split/master/res/icon.ico" alt="LiveSplit" height="42" width="45" align="top"/> AutoSplit
 
 This program compares split images to a capture region of any window (OBS, xsplit, etc.) and automatically hits your split hotkey when there is a match. It can be used in tandem with any speedrun timer that accepts hotkeys (LiveSplit, wsplit, etc.). The purpose of this program is to remove the need to manually press your split hotkey and also increase the accuracy of your splits.
 
@@ -14,14 +14,14 @@ This program compares split images to a capture region of any window (OBS, xspli
 
 ### Opening the program
 
-- Download the [latest version](/Toufool/Auto-Split/releases)
+- Download the [latest version](/../../releases)
 - Extract the file and open AutoSplit.exe.
 
 ### Building
 
 (This is not required for normal use)
 
-- Microsoft Visual C++ 14.0 or greater may be required. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) 
+- Microsoft Visual C++ 14.0 or greater may be required. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
 - Read [requirements.txt](/scripts/requirements.txt) for information on how to run/build the python code
   - Run `.\scripts\install.bat` to install all dependencies
   - Run the app directly with `py .\src\AutoSplit.py`
@@ -34,7 +34,7 @@ This program compares split images to a capture region of any window (OBS, xspli
 - Images can be any size.
 - Images are matched in alphanumerical order.
 - Recommended filenaming convention: `001_SplitName.png, 002_SplitName.png, 003_SplitName.png`...
-- Custom split image settings are handled in the filename. See how [here](https://github.com/Toufool/Auto-Split#custom-split-image-settings).
+- Custom split image settings are handled in the filename. See how [here](#custom-split-image-settings).
 - Images can be created using Print Screen, [Snipping Tool](https://support.microsoft.com/en-us/help/4027213/windows-10-open-snipping-tool-and-take-a-screenshot), or AutoSplit's Take Screenshot button.
 
 ## Capture Region
@@ -86,8 +86,8 @@ This program compares split images to a capture region of any window (OBS, xspli
 
 - Each split image can have different thresholds, pause times, delay split times, loop amounts, and can be flagged.
 - These settings are handled in the image's filename.
-- Custom thresholds are place between parenthesis `()` in the filename and the custom thresholds checkbox must be checked. All images must have a custom threshold if the box is checked.
-- Custom pause times are placed between square brackets `[]` in the filename and the custom pause times checkbox must be checked. All images must have a custom threshold if the box is checked.
+- Custom thresholds are place between parenthesis `()` in the filename. This value will override the default threshold.
+- Custom pause times are placed between square brackets `[]` in the filename. This value will override the default pause time.
 - Custom delay times are placed between hash signs `##` in the filename. Note that these are in milliseconds. For example, a 10 second split delay would be `#10000#`. You cannot skip or undo splits during split delays.
 - Image loop amounts are placed between at symbols `@@` in the filename. For example, a specific image that you want to split 5 times in a row would be `@5@`. The current loop # is conveniently located beneath the current split image.
 - Flags are placed between curly brackets `{}` in the filename. Multiple flags are placed in the same set of curly brackets. Current available flags:
@@ -103,13 +103,19 @@ This program compares split images to a capture region of any window (OBS, xspli
 
 ### How to Create a Masked Image
 
+Masked images are very useful if only a certain part of the capture region is consistent (for example, consistent text on the screen, but the background is always different). Histogram or L2 norm comparison is recommended if you use any masked images. It is highly recommended that you do NOT use pHash comparison if you use any masked images, as it is very inaccurate.
+
 The best way to create a masked image is to set your capture region as the entire game screen, take a screenshot, and use a program like [paint.net](https://www.getpaint.net/) to "erase" (make transparent) everything you don't want the program to compare. More on how to creating images with transparency using paint.net can be found in [this tutorial](https://www.youtube.com/watch?v=v53kkUYFVn8). For visualization, here is what the capture region compared to a masked split image looks like if you would want to split on "Shine Get!" text in Super Mario Sunshine:
 
 ![Mask Example](res/mask_example_image.PNG)
 
 ### Reset image
 
-You can have one (and only one) image with the keyword `reset` in its name. AutoSplit will press the reset button when it finds this image. This image will only be used for resets and it will not be tied to any split. You can set a probability and pause time for it. A custom threshold MUST be applied to this image. The pause time is the amount of seconds AutoSplit will wait before checking for the reset image once the run starts. Also the image can be masked, for example: `Reset_(0.95)_[10].png`.
+You can have one (and only one) image with the keyword `reset` in its name. AutoSplit will press the reset button when it finds this image. This image will only be used for resets and it will not be tied to any split. You can set a probability and pause time for it. The pause time is the amount of seconds AutoSplit will wait before checking for the reset image once the run starts. For example: `Reset_(0.95)_[10].png`.
+
+### Start image
+
+The start image is similar to the reset image. You can only have one start image with the keyword `start_auto_splitter`.You can reload the image using the "`Reload Start Image`" button. The pause time is the amount of seconds AutoSplit will wait before checking for the start image once a run ends/is reset.
 
 ### Timer Global Hotkeys
 
@@ -154,22 +160,27 @@ If this option is disabled, when the reset hotkey is hit, the reset button is pr
 - The settings in the settings file include split image directory, capture region, capture region dimensions, fps limit, threshold and pause time settings, all hotkeys, "Group dummy splits when undoing/skipping" check box, "Loop Split Images" check box, and "Auto Start On Reset" check box.
 - If you are upgrading to Windows 11, it's possible that save files may not transfer perfectly. You may need to readjust or reselect your Capture Region, for example.
 
+## LiveSplit integration
+
+There is a LiveSplit Component available that will directly connect AutoSplit with LiveSplit. You can get it [here](/KaDiWa4/LiveSplit.AutoSplitIntegration).
+
 ## Known Limitations
 
 - For many games, it will be difficult to find a split image for the last split of the run.
 - The window of the capture region cannot be minimized.
 
 ## Resources
 
-- Still need help? [Open an issue](https://github.com/Toufool/Auto-Split/issues)
+- Still need help? [Open an issue](../../issues)
 - Join the [AutoSplit Discord](https://discord.gg/Qcbxv9y)
 
 ## Credits
 
-- <https://github.com/harupy/> for the snipping tool code that I used to integrate into the autosplitter.
+- [Harutaka Kawamura](https://github.com/harupy/) for the snipping tool code that I used to integrate into the autosplitter.
 - [amaringos](https://twitter.com/amaringos) for the icon.
 - [ZanasoBayncuh](https://twitter.com/ZanasoBayncuh) for motivating me to start this project back up and for all of the time spent testing and suggesting improvements.
 - [Avasam](https://twitter.com/Avasam06) for their continued work on making an incredible amount of improvements and changes to AutoSplit while I have not had the time/motivation to do so.
+- [KaDiWa](https://github.com/KaDiWa4) for the LiveSplit integration.
 - Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz).
 
 ## Donate

scripts/requirements.txt

@@ -2,7 +2,7 @@
 #
 # Python: CPython 3.9+
 #
-# Usage: .scripts/install.bat
+# Usage: ./scripts/install.bat
 #
 # If you're having issues with the libraries, you might want to first run:
 # pip3.9 uninstall -r requirements.txt

src/AutoSplit.py

@@ -13,7 +13,6 @@
 import threading
 import time
 
-from hotkeys import send_hotkey
 from menu_bar import about, VERSION, viewHelp
 import error_messages
 import compare
@@ -23,6 +22,7 @@
 
 
 class AutoSplit(QtWidgets.QMainWindow, design.Ui_MainWindow):
+    from hotkeys import send_command
     from settings_file import saveSettings, saveSettingsAs, loadSettings, haveSettingsChanged, getSaveSettingsValues
     from screen_region import selectRegion, selectWindow, alignRegion
     from hotkeys import afterSettingHotkey, setSplitHotkey, setResetHotkey, setSkipSplitHotkey, setUndoSplitHotkey, setPauseHotkey
@@ -341,7 +341,7 @@ def startImageFunction(self):
                 or (start_image_similarity >= start_image_threshold and start_image_flags & 0x04 == 0):
             def split():
                 self.hasSentStart = False
-                send_hotkey(self.splitLineEdit.text())
+                self.send_command("start")
                 time.sleep(1 / self.fpslimitSpinBox.value())
                 self.startAutoSplitter()
 
@@ -470,7 +470,7 @@ def checkFPS(self):
 
     # undo split button and hotkey connect to here
     def undoSplit(self):
-        if self.undosplitButton.isEnabled() == False and self.is_auto_controlled == False:
+        if self.undosplitButton.isEnabled() == False and not self.is_auto_controlled:
             return
 
         if self.loop_number != 1 and self.groupDummySplitsCheckBox.isChecked() == False:
@@ -493,7 +493,7 @@ def undoSplit(self):
     # skip split button and hotkey connect to here
     def skipSplit(self):
 
-        if self.skipsplitButton.isEnabled() == False and self.is_auto_controlled == False:
+        if self.skipsplitButton.isEnabled() == False and not self.is_auto_controlled:
             return
 
         if self.loop_number < self.split_image_loop_amount[self.split_image_number] and self.groupDummySplitsCheckBox.isChecked() == False:
@@ -577,26 +577,24 @@ def autoSplitter(self):
         # according to all of the settings selected by the user.
         for image in self.split_image_filenames:
             # Test for image without transparency
-            if cv2.imread(self.split_image_directory + image, cv2.IMREAD_COLOR) is None:
-                # Test for image with transparency
-                if cv2.imread(self.split_image_directory + image, cv2.IMREAD_UNCHANGED) is None:
-                    # Opencv couldn't open this file as an image, this isn't a correct
-                    # file format that is supported
-                    self.guiChangesOnReset()
-                    error_messages.imageTypeError(image)
-                    return
-                else:
-                    # TODO: Now that we know the image has transparency, error out if it is completely transparent
-                    # Will fix https://github.com/Toufool/Auto-Split/issues/52
-                    pass
+            if (cv2.imread(self.split_image_directory + image, cv2.IMREAD_COLOR) is None
+                    # Test for image with transparency
+                    and cv2.imread(self.split_image_directory + image, cv2.IMREAD_UNCHANGED) is None):
+                # Opencv couldn't open this file as an image, this isn't a correct
+                # file format that is supported
+                self.guiChangesOnReset()
+                error_messages.imageTypeError(image)
+                return
 
-            #error out if there is a {p} flag but no pause hotkey set.
-            if self.pausehotkeyLineEdit.text() == '' and split_parser.flags_from_filename(image) & 0x08 == 0x08 and self.is_auto_controlled == False:
+            # error out if there is a {p} flag but no pause hotkey set and is not auto controlled.
+            if (self.pausehotkeyLineEdit.text() == ''
+                    and split_parser.flags_from_filename(image) & 0x08 == 0x08
+                    and not self.is_auto_controlled):
                 self.guiChangesOnReset()
                 error_messages.pauseHotkeyError()
                 return
 
-        if self.splitLineEdit.text() == '' and self.is_auto_controlled == False:
+        if self.splitLineEdit.text() == '' and not self.is_auto_controlled:
             self.guiChangesOnReset()
             error_messages.splitHotkeyError()
             return
@@ -612,8 +610,8 @@ def autoSplitter(self):
                 error_messages.multipleKeywordImagesError('reset')
                 return
 
-        # If there is no reset hotkey set but a reset image is present, throw an error.
-        if self.resetLineEdit.text() == '' and self.reset_image is not None and self.is_auto_controlled == False:
+        # If there is no reset hotkey set but a reset image is present, and is not auto controlled, throw an error.
+        if self.resetLineEdit.text() == '' and self.reset_image is not None and not self.is_auto_controlled:
             self.guiChangesOnReset()
             error_messages.resetHotkeyError()
             return
@@ -689,11 +687,7 @@ def autoSplitter(self):
                 if self.shouldCheckResetImage():
                     reset_similarity = self.compareImage(self.reset_image, self.reset_mask, capture)
                     if reset_similarity >= self.reset_image_threshold:
-                        if self.is_auto_controlled:
-                            print("reset", flush = True)
-                        else:
-                            send_hotkey(self.resetLineEdit.text())
-                        self.reset()
+                        self.send_command("reset")
 
                 if self.checkForReset():
                     return
@@ -722,7 +716,7 @@ def autoSplitter(self):
                 else:
                     self.highestsimilarityLabel.setText(' ')
 
-                if self.is_auto_controlled == False:
+                if not self.is_auto_controlled:
                     # if its the last split image and last loop number, disable the skip split button
                     if (self.split_image_number == self.number_of_split_images - 1 and self.loop_number == self.split_image_loop_amount[self.split_image_number]) or (self.groupDummySplitsCheckBox.isChecked() == True and self.dummy_splits_array[self.split_image_number:].count(False) <= 1):
                         self.skipsplitButton.setEnabled(False)
@@ -787,10 +781,7 @@ def autoSplitter(self):
 
                             reset_similarity = self.compareImage(self.reset_image, self.reset_mask, capture)
                             if reset_similarity >= self.reset_image_threshold:
-                                if self.is_auto_controlled:
-                                    print("reset", flush = True)
-                                else:
-                                    send_hotkey(self.resetLineEdit.text())
+                                self.send_command("reset")
                                 self.reset()
                                 continue
 
@@ -800,15 +791,9 @@ def autoSplitter(self):
 
                 # if {p} flag hit pause key, otherwise hit split hotkey
                 if (self.flags & 0x08 == 0x08):
-                    if self.is_auto_controlled:
-                        print("pause", flush = True)
-                    else:
-                        send_hotkey(self.pausehotkeyLineEdit.text())
+                    self.send_command("pause")
                 else:
-                    if self.is_auto_controlled:
-                        print("split", flush = True)
-                    else:
-                        send_hotkey(self.splitLineEdit.text())
+                    self.send_command("split")
 
             # increase loop number if needed, set to 1 if it was the last loop.
             if self.loop_number < self.split_image_loop_amount[self.split_image_number]:
@@ -837,7 +822,7 @@ def autoSplitter(self):
                 self.currentSplitImage.setAlignment(QtCore.Qt.AlignmentFlag.AlignCenter)
                 self.imageloopLabel.setText('Image Loop #:     -')
 
-                if self.is_auto_controlled == False:
+                if not self.is_auto_controlled:
                     # if its the last split image and last loop number, disable the skip split button
                     if (self.split_image_number == self.number_of_split_images - 1 and self.loop_number == self.split_image_loop_amount[self.split_image_number]) or (self.groupDummySplitsCheckBox.isChecked() == True and self.dummy_splits_array[self.split_image_number:].count(False) <= 1):
                         self.skipsplitButton.setEnabled(False)
@@ -875,7 +860,7 @@ def autoSplitter(self):
 
                         reset_similarity = self.compareImage(self.reset_image, self.reset_mask, capture)
                         if reset_similarity >= self.reset_image_threshold:
-                            send_hotkey(self.resetLineEdit.text())
+                            self.send_command("reset")
                             self.reset()
                             continue
 
@@ -892,7 +877,7 @@ def guiChangesOnStart(self):
         self.groupDummySplitsCheckBox.setEnabled(False)
         self.startImageReloadButton.setEnabled(False)
 
-        if self.is_auto_controlled == False:
+        if not self.is_auto_controlled:
             self.startautosplitterButton.setEnabled(False)
             self.resetButton.setEnabled(True)
             self.undosplitButton.setEnabled(True)
@@ -917,7 +902,7 @@ def guiChangesOnReset(self):
         self.groupDummySplitsCheckBox.setEnabled(True)
         self.startImageReloadButton.setEnabled(True)
 
-        if self.is_auto_controlled == False:
+        if not self.is_auto_controlled:
             self.startautosplitterButton.setEnabled(True)
             self.resetButton.setEnabled(False)
             self.undosplitButton.setEnabled(False)

src/AutoSplit.spec

@@ -39,8 +39,22 @@ def is_digit(key):
         return False
 
 
+def send_command(self, command):
+    if self.is_auto_controlled:
+        print(command, flush=True)
+    else:
+        if command == "split" or command == "start":
+            _send_hotkey(self.splitLineEdit.text())
+        elif command == "pause":
+            _send_hotkey(self.pausehotkeyLineEdit.text())
+        elif command == "reset":
+            _send_hotkey(self.resetLineEdit.text())
+        else:
+            raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command")
+
+
 # Supports sending the appropriate scan code for all the special cases
-def send_hotkey(key_or_scan_code):
+def _send_hotkey(key_or_scan_code):
     hotkey_type = type(key_or_scan_code)
 
     # Deal with regular inputs