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.
- Windows 7 and 10.
- Download the latest version
- Extract the file and open AutoSplit.exe.
- Supported image file types: .png, .jpg, .jpeg, .bmp, and more.
- 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.
- Images can be created using Print Screen, Snipping Tool, or AutoSplit's Take Screenshot button.
- This is the region that your split images are compared to. Usually, this is going to be the full game screen.
- Click "Select Region"
- Click and drag to form a rectangle over the region you want to capture.
- Adjust the x, y, width, and height of the capture region manually to make adjustments as needed.
- If you want to align your capture region by using a reference image, click "Align Region"
- You can freely move the window that the program is capturing, but resizing the window will cause the capture region to change.
- Once you are happy with your capture region, you may unselect Live Capture Region to decrease CPU usage if you wish.
- You can save a screenshot of the capture region to your split image folder using the Take Screenshot button.
- Calculates the maximum comparison rate of the capture region to split images. This value will likely be much higher than needed, so it is highly recommended to limit your FPS depending on the frame rate of the game you are capturing.
- There are three comparison methods to choose from: L2 Norm, Histograms, and pHash.
- L2 Norm: This method finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different.
- Histograms: An explanation on Histograms comparison can be found here. This is a great method to use if you are using several masked images.
- pHash: An explanation on pHash comparison can be found here. It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate.
- Note: v1.0 used L2 Norm.
- Displays the live similarity between the capture region and the current split image. This number is between 0 and 1, with 1 being a perfect match.
- Shows the highest similarity between the capture region and current split image.
- When the live similarity goes above this value, the program hits your split hotkey and moves to the next split image.
- Time in seconds that the program stops comparison after a split. Useful for if you have two of the same split images in a row and want to avoid double-splitting. Also useful for reducing CPU usage.
- Each split image can have different thresholds, pause times, 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. - Flags are placed between curly brackets
{}in the filename. Multiple flags are placed in the same set of curly brackets. Current available flags:- {d} dummy split image. When matched, it moves to the next image without hitting your split hokey.
- {m} masked split image. This allows you to customize what you want compared in your split image by using transparency. Transparent pixels in the split image are ignored when comparing. This is 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). These images MUST be .png and contain transparency. For more on this, see How to Create a Masked Image. 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
- Filename examples:
001_SplitName_(0.9)_[10].pngis a split image with a threshold of 0.9 and a pause time of 10 seconds.002_SplitName_(0.9)_[10]_{d}.pngis the second split image with a threshold of 0.9, pause time of 10, and is a dummy split.
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 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. The last thing you need to do is add {m} to the filename. 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:
- Click "Set Hotkey" on each hotkey to set the hotkeys to AutoSplit. Start / Split hotkey must be the same as the one used in your preferred timer program in order for the splitting to work properly.
- Make sure that Global Hotkeys are enabled in your speedrun timer.
- All of these actions can also be handled by their corresponding buttons.
- Starting your timer/AutoSplit is still manual.
- 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.
- When setting your region, you may only see a black image. This is caused by hardware acceleration. You may be able to disable this through the application itself like in Google Chrome. If not, this can also be disabled through Windows. NOTE: If you notice any computer performance issues after disabling hardware acceleration, re-enable it.
- Known to currently have issues selecting a region in Streamlabs OBS (only shows black image).
- Using numpad number keys when numlock is on does not split correctly. Either avoid using numpad or turn numlock off to avoid this issue.
- LiveSplit and wsplit will not split correctly if you are holding shift, ctrl, or alt when a match occurs.
- Numlock on keys are linked to numlock-off keys. For example, if you set your reset hotkey to 2, you can hit arrow down and it will reset and vice versa.
- Still need help? Open an issue
- Join the AutoSplit Discord
- https://github.com/harupy/ for the snipping tool code that I used to integrate into the autosplitter.
- amaringos for the icon.
- ZanasoBayncuh for motivating me to start this project back up and for all of the time spent testing and suggesting improvements.
- Created by Toufool and Faschz.
If you enjoy using the program, please consider donating. Thank you!
