Skip to content

Commit 5261fc3

Browse files
authored
more 1.6.0 README changes
1 parent 8cf8009 commit 5261fc3

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Easy to use image comparison based auto splitter for speedrunning on console or PC.
55

6-
This program compares split images to a capture region of any window (OBS, Streamlabs, etc.) and automatically hits your split hotkey when there is a match. It can also be used to start and reset your timer, allowing for it to take full control of starting, splitting, and resetting your timer without ever having to touch a hotkey. It can be used in tandem with any speedrun timer that accepts hotkeys (LiveSplit, wsplit, etc.), but can be integrated with LiveSplit.
6+
This program can be used to automatically start, split, and reset your preferred speedrun timer by comparing images to a capture region. This allows you to focus more on your speedrun and less on managing your timer. It also improves the accuracy of your splits. It can be used in tandem with any speedrun timer that accepts hotkeys (LiveSplit, wsplit, etc.), and can be integrated with LiveSplit.
77

88
![Example](res/example1.6.0.gif)
99

@@ -17,7 +17,7 @@ This program compares split images to a capture region of any window (OBS, Strea
1717

1818
### Opening the program
1919

20-
- Download the [latest version](/../../releases)
20+
- Download the [latest version](/../../releases/latest)
2121
- Extract the file and open AutoSplit.exe.
2222

2323
### Building
@@ -38,7 +38,7 @@ This program compares split images to a capture region of any window (OBS, Strea
3838
- Images are matched in alphanumerical order.
3939
- Recommended filenaming convention: `001_SplitName.png, 002_SplitName.png, 003_SplitName.png`...
4040
- Custom split image settings are handled in the filename. See how [here](#custom-split-image-settings).
41-
- 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.
41+
- To create split images, it is recommended to use AutoSplit's Take Screenshot button for accuracy. However, images can be created using any method including Print Screen and [Snipping Tool](https://support.microsoft.com/en-us/help/4027213/windows-10-open-snipping-tool-and-take-a-screenshot).
4242

4343
## Capture Region
4444

@@ -60,10 +60,9 @@ This program compares split images to a capture region of any window (OBS, Strea
6060
### Comparison Method
6161

6262
- There are three comparison methods to choose from: L2 Norm, Histograms, and pHash.
63-
- 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.
63+
- L2 Norm: This method should be fine to use for most cases. it 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.
6464
- Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images.
6565
- pHash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate.
66-
- Note: v1.0 used L2 Norm.
6766

6867
### Show Live Similarity
6968

@@ -110,7 +109,7 @@ This program compares split images to a capture region of any window (OBS, Strea
110109
- `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds.
111110
- `002_SplitName_(0.9)_[10]_{d}.png` is the second split image with a threshold of 0.9, pause time of 10, and is a dummy split.
112111
- `003_SplitName_(0.85)_[20]_#3500#.png` is the third split image with a threshold of 0.85, pause time of 20 and has a delay split time of 3.5 seconds.
113-
- `004_SplitName(0.9)_[10]_#3500#_@3@_{b}.png` is the fourth split image with a threshold of 0.9, pause time of 10 seconds, delay split time of 3.5 seconds, will loop 3 times, and will split when similarity is below the threshold rather than above.
112+
- `004_SplitName_(0.9)_[10]_#3500#_@3@_{b}.png` is the fourth split image with a threshold of 0.9, pause time of 10 seconds, delay split time of 3.5 seconds, will loop 3 times, and will split when similarity is below the threshold rather than above.
114113

115114
### How to Create a Masked Image
116115

@@ -126,7 +125,7 @@ You can have one (and only one) image with the keyword `reset` in its name. Auto
126125

127126
### Start image
128127

129-
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.
128+
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. Delay times will be used to delay starting your timer after the threshold is met.
130129

131130
### Timer Global Hotkeys
132131

@@ -166,18 +165,19 @@ If this option is disabled, when the reset hotkey is hit, the reset button is pr
166165

167166
- Settings files use the extension `.pkl`. Settings files can be saved and opened by using File -> Save Settings As... and File -> Load Settings. A settings file can be loaded upon opening AutoSplit if placed in the same directory as AutoSplit.exe.
168167
- 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.
168+
- You can save multiple settings files, which is useful if you speedrun multiple games.
169169
- 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.
170170

171171
## LiveSplit Integration
172172

173173
The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit. LiveSplit integration is only supported in AutoSplit v1.6.0 or higher. This integration will allow you to:
174174

175-
- Use hotkeys directly from LiveSplit to control AutoSplit.
175+
- Use hotkeys directly from LiveSplit to control AutoSplit and LiveSplit together
176176
- Load AutoSplit and any AutoSplit settings automatically when opening a LiveSplit layout.
177177

178178
### LiveSplit Integration Tutorial
179179

180-
- Click [here](https://github.com/Toufool/LiveSplit.AutoSplitIntegration/raw/main/update/Components/LiveSplit.AutoSplitIntegration.dll) to download the component.
180+
- Click [here](https://github.com/Toufool/LiveSplit.AutoSplitIntegration/raw/main/update/Components/LiveSplit.AutoSplitIntegration.dll) to download the latest component.
181181
- Place the .dll file into your `[...]\LiveSplit\Components` folder.
182182
- Open LiveSplit -> Right Click -> Edit Layout -> Plus Button -> Control -> AutoSplit Integration.
183183
- Click Layout Settings -> AutoSplit Integration
@@ -194,18 +194,19 @@ The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit
194194

195195
## Resources
196196

197-
- Still need help? [Open an issue](../../issues)
197+
Still need help?
198+
- [Open an issue](../../issues)
198199
- Join the [AutoSplit Discord](https://discord.gg/Qcbxv9y)
199200

200201
## Credits
201202

203+
- Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz).
202204
- [Harutaka Kawamura](https://github.com/harupy/) for the snipping tool code that I used to integrate into the autosplitter.
203205
- [amaringos](https://twitter.com/amaringos) for the icon.
204206
- [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.
205207
- [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.
206208
- [KaDiWa](https://github.com/KaDiWa4) for the LiveSplit integration.
207209
- [Tyron18](https://twitter.com/Tyron18_) for assisting with Windows 11 testing.
208-
- Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz).
209210

210211
## Donate
211212

0 commit comments

Comments
 (0)