v1.2.0 changes to README

README.md

@@ -17,16 +17,20 @@ This program compares split images to a capture region of any window (OBS, xspli
 - Download the [latest version](https://github.com/austinryan/Auto-Split/releases)
 - Extract the file and open AutoSplit.exe.
 
-## SPLIT IMAGE FOLDER
+## Split Image Folder
 - Supported image file types: .png, .jpg, .jpeg, .bmp, and [more](https://docs.opencv.org/3.0-beta/modules/imgcodecs/doc/reading_and_writing_images.html#imread).
 - 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](https://github.com/Toufool/Auto-Split#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
+## Capture Region
+- 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.
@@ -39,12 +43,12 @@ This program compares split images to a capture region of any window (OBS, xspli
 ### Comparison Method
 - 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](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html)
-  - pHash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html)
-- Note: v1.0.0 used L2 Norm.
+  - 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 masked images.
+  - 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.
+- Note: v1.0 used L2 Norm.
 
 ### Show Live Similarity
-- Displays the live similarity between the capture region and your split image. This number is between 0 and 1, with 1 being a perfect match.
+- 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.
 
 ### Show Highest Similarity
 - Shows the highest similarity between the capture region and current split image.
@@ -60,9 +64,15 @@ This program compares split images to a capture region of any window (OBS, xspli
 - 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. When matched, it moves to the next image without hitting your split hokey.
-- Filename example: `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds.
+- 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. Ignores transparent pixels in the split image 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). For more on this, see [How to Create a Masked Image](https://github.com/Toufool/Auto-Split/blob/master/README.md#how-to-create-a-masked-image). Histogram comparison is recommended for masked images. It is highly recommended that you do NOT use pHash comparison for masked split images, as it is very inaccurate.
+- Filename examples: 
+  - `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds.
+  - `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.
+
+### How to Create a Masked Image
+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 an example, 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: need to add image here
 
 ### Timer Global Hotkeys
 - 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.
@@ -71,7 +81,6 @@ This program compares split images to a capture region of any window (OBS, xspli
 - All of these actions can also be handled by their corresponding buttons.
 
 ## Known Limitations
-- Transparency in an image is not seen as a mask or "nothing." It gets transformed into solid white.
 - 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.
@@ -85,8 +94,13 @@ This program compares split images to a capture region of any window (OBS, xspli
 - Join the [AutoSplit Discord](https://discord.gg/Qcbxv9y)
 
 
-### Credits
+## Credits
 - 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.
 - Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz).
+
+## Donate
+If you enjoy using the program, please consider donating. Thank you!  
+
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?token=smI9iwHZ_FYTd0BZVCIphAeuNuk6UcamAceGChZUXp_7eik04kiXvhBsnVMCkgWDYhWfjG&country.x=US&locale.x=)