Merge pull request blegas78#14 from justsaft/master

README.md

@@ -2,70 +2,48 @@
 
 I am active in the Horizon Zero Dawn and The Last Of Us (1/2) communities.  These efforts are intended to aid the communities to make live speedrunning times more comparable and therefore, hopefully,  more enjoyable.  If the tools are effective enough, this will eliminate the need to manually calculate your In-Game Time (IGT) through use of a video editor, which can be a laborious task for both runners and leaderboard moderators.
 
-Video with information and installation: [https://www.youtube.com/watch?v=lmLSUKhvSrg](https://www.youtube.com/watch?v=lmLSUKhvSrg) (to be updated)
+These load removers are based on reading the HUD in particular places. Both the HZD and TLOU2 efforts are intended to be used with LiveSplit using the [`Video Auto Splitter (VAS)`](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases) component. Instructions for installation are already provided by the VAS github, but I will cover them as well.
 
-The latest load removers (.vas files) can be downloaded on the [Release Page here](https://github.com/blegas78/autoSplitters/releases)
+The VAS is only one necessary component. You also need to get a video source from your game into the VAS component.
+Since OBS version 26 the previosly required [OBS-VirtualCam](https://github.com/CatxFish/obs-virtual-cam) is no longer strictly needed, as from this release onwards a virtual cam feature is shipped with OBS itself. XSplit also has a Virtual Camera feature.
 
+Video with information and installation: [`https://www.youtube.com/watch?v=lmLSUKhvSrg`](https://www.youtube.com/watch?v=lmLSUKhvSrg) (to be updated)
 
-##  Do they work?
+#### The latest load removers (`.vas` files) can be downloaded on the [`Releases Page`](https://github.com/blegas78/autoSplitters/releases)
 
-These seem to work VERY well on my end, however different setups may cause different issues.  Also there could be some scenerios in which they break.  Please see information in either game to learn more about known issues, if any exist.
+###### Please also see the change log in each load remover's description regarding the reason for updates to `.vas` files.
 
+##  Do they work?
 
-Although I *HIGHLY* Recommend testing this before attempting a run each day by doing a quick test.
-With all of the above up and running and showing IGT,  try to start the timer then invoke a load based on whatever the definition of a load is for your game.
+These seem to work VERY well on my end, however different setups may cause different issues. Also there could be some scenerios in which they break. Please see information in either game to learn about known issues, if any exist.
 
-###### Please also see the Change Log in each load remover description regarding the reason for updates to .vas files.
-###### If you encounter a problem or issue, feel free to check the troubleshooting section further down below.
+###### If you encounter a problem or issue, feel free to check the troubleshooting section further down below or reach out to one of us on Discord.
 
+Although I **HIGHLY** Recommend testing this before attempting a run each day by doing a quick test.
+With all of the above up and running and showing IGT, try to start the timer then invoke a load based on whatever the definition of a load is for your game.
 
 ## Setup
 
-#### This assumes that you already have LiveSplit installed.  If not, please visit the [LiveSplit release page](https://github.com/LiveSplit/LiveSplit/releases).
-I recommend a reboot before installation to avoid any headaches.
-
-
-### Requirements
-
-These load removers are based on reading the HUD in particular places. Both the HZD and TLOU2 efforts are intended to be used with LiveSplit using the [Video Auto Splitter (VAS)](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases) component. Instructions for installation are already provided by the VAS github, but I will cover them as well.
-
-The VAS is only one necessary component. You also need to get a video source from your game into the VAS component.
-Since OBS version 26 the previosly required [OBS-VirtualCam](https://github.com/CatxFish/obs-virtual-cam) is no longer strictly needed, as from this release onwards a virtual cam feature is shipped with OBS itself. XSplit also has a Virtual Camera feature.
-
-#### Am I required to have a capture card?
-
-I have reports from some users that have had success using PS4 share instead of a capture card.
-###### Thank you Leiberton and Charlatan_11235 for testing!
-
-#### List of versions I use for development and testing
-
-There may be issues in installation for different versions of software, but don't be afraid to try versions different from my own. Please check the troubleshooting section if you encounter a problem.
-
- - [Livesplit 1.8.10](https://github.com/LiveSplit/LiveSplit/releases)
- - [Video Auto Splitter 0.5.2.3](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases)
- - [OBS 25.0.4](https://github.com/obsproject/obs-studio/releases)
- - [OBS-VirtualCam 2.0.4](https://github.com/CatxFish/obs-virtual-cam/releases)
- - [The Game Profile (.vas file) for your game from the Release Page here](https://github.com/blegas78/autoSplitters/releases)
-
-###### I have also heard reports that versions newer than the above list also work. Thank you Aquila_Ezio!
+##### This assumes that you already have LiveSplit installed.  If not, please visit the [LiveSplit release page](https://github.com/LiveSplit/LiveSplit/releases).
 
+I recommend a reboot before installation to avoid any headaches.
 
 ### 1. Installation of the LiveSplit VAS component
 
-1. Download the [Video Auto Splitter (VAS)](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases) component
+1. Download the [``Video Auto Splitter (VAS)``](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases) component
 2. Extract the `.zip` file, there you should see 5 total `.dll` files
-3. Navigate to where your LiveSplit is installed.  It should be in a directory named something like "LiveSplit_1.8.10" (or different numbers for your version). There is no proper installation tool for LiveSplit, it just runs out of the box so it could still be in your "Downloads" directory if you never moved it.
-4. Inside of the LiveSplit directory, navigate to the "Components" directory.  There should be a bunch of `.dll` files.
-5. Copy all 5 VAS `.dll` files from step 2 into this "Components" directory.
+3. Navigate to where your LiveSplit is installed.  It should be in a directory named something like `LiveSplit_1.8.10` (or different numbers depending on your version). There is no proper installation tool for LiveSplit, it just runs out of the box so it could still be in your `Downloads` directory if you never moved it.
+4. Inside of the LiveSplit directory, navigate to the `Components` directory.  There should be a bunch of `.dll` files.
+5. Copy all 5 VAS `.dll` files from step 2 into this `Components` directory.
 
-Installation of the VAS should be complete.  You will at a minimum need to restart LiveSplit.
+> Installation of the VAS should be complete. You will at a minimum need to restart LiveSplit.
 
 
 ### 2. Feeding the game video feed to LiveSplit
 
 The next thing that needs to be done is share the video from OBS to LiveSplit.
 
-###### This assumes that you already have some flavor of OBS installed.  If not, please visit the [OBS release page](https://github.com/obsproject/obs-studio/releases). A recording software by the name of XSplit also has a Virtual Cam feature wich will not be covered here.
+###### This assumes that you already have some flavor of OBS installed.  If not, please visit the [OBS releases page](https://github.com/obsproject/obs-studio/releases). A recording software by the name of XSplit also has a Virtual Cam feature wich will not be covered here.
 
 ### 2.1 Using OBS' built-in vitual cam
 
@@ -94,14 +72,14 @@ Just hit `Start Virtual Cam` located in the same menu as `Start Recording`
 9.  Most importantly in these settings, remember the name of `Target Camera`, for me, it is `OBS-Camera`
 10. Click on the "Start" button
 
-> Your game feed should now be fed to a virtual webcam with the name designated under "Target Camera."
-
 ###### IMPORTANT: Every time that you close/open OBS, you will need to navigate to the VirtualCam filter and click that "Start" button.  It will NOT auto-start each time OBS is restarted.
 
-###### Tip: If you're unsure that virtualcam is actually running, test it using any program that makes use of a webcam, e.g. Discord. (Go to Settings -> Voice- & Videochat -> Video settings -> Click the 'Test' button)
+> Your game feed should now be fed to a virtual webcam with the name designated under "Target Camera."
+
+###### Tip: If you're unsure that virtualcam is actually running, test it using any program that makes use of a webcam, e.g. Discord. (Go to ``Settings`` -> ``Voice- & Videochat`` -> ``Video settings`` -> Click the ``Test`` button)
 
 
-### 3. PlayStation Settings
+### 3. PlayStation™ Settings
 
 ###### These instructions should also apply to the PS5, but they might have a different name.
 
@@ -111,7 +89,7 @@ Navigate to `Settings`
 
 #### Under: `Sound and Screen` -> `Display Area Settings`:
 
- - Enlarge the setting to the maximum setting, until "Enlarge" becomes greyed.
+ - Enlarge the setting to the maximum setting, until `Englarge` becomes greyed.
 
 #### Under: `Sound and Screen` -> `Video Output Settings` -> `Video Output Information`:
 
@@ -122,7 +100,7 @@ Navigate to `Settings`
 
 ### 4. Video Auto Splitter
 
-1. Download your desired `.vas` file from the [Release Page here](https://github.com/blegas78/autoSplitters/releases)
+1. Download your desired `.vas` file from the [``Releases Page``](https://github.com/blegas78/autoSplitters/releases)
 2. Open LiveSplit and your layout if not open
 3. At this stage your timer is still probably checking against Real Time Attack (RTA) instead of the loadless IGT. Right-click the LiveSplit window, then select `Compare Against` -> `Game Time`
 4. Right-click the LiveSplit window again, this time choose `Edit Layout...`
@@ -134,6 +112,25 @@ Navigate to `Settings`
 > If your game is running, with OBS and VirtualCam running, you should see a live preview of your game in this tab
 10. Now head over to the game's specific readme file and continue from there
 
+## SAQ (sometimes asked questions) [![blegasLurk](https://static-cdn.jtvnw.net/emoticons/v2/303139865/default/dark/1.0)]()
+
+#### Am I required to have a capture card (for runs on PlayStation)?
+
+I have reports from some users that have had success using PS4 share instead of a capture card.
+###### Thank you Leiberton and Charlatan_11235 for testing!
+
+#### What versions of software do you use for development and testing?
+
+There may be issues in installation for different versions of software, but don't be afraid to try versions different from my own. Please check the troubleshooting section if you encounter a problem.
+
+ - [Livesplit 1.8.10](https://github.com/LiveSplit/LiveSplit/releases)
+ - [Video Auto Splitter 0.5.2.3](https://github.com/ROMaster2/LiveSplit.VideoAutoSplit/releases)
+ - [OBS 25.0.4](https://github.com/obsproject/obs-studio/releases)
+ - [OBS-VirtualCam 2.0.4](https://github.com/CatxFish/obs-virtual-cam/releases)
+ - [The Game Profile (.vas file) for your game from the Release Page here](https://github.com/blegas78/autoSplitters/releases)
+
+###### I have also heard reports that versions newer than the above list also work. Thank you Aquila_Ezio!
+
 
 ## General troubleshooting
 
@@ -189,15 +186,15 @@ I will build this section more and more as people run into issues with setup. Pl
 
 - Kevin700P has had trouble streaming and using the load remover at the same time.  Turns out his phone was plugged into his stream computer (a laptop) and unplugging the phone lets him do both at once.
 - Pdub had configured his capture card to a resolution of 1280x720 and it caused issues.
-- ikeden had a filter for increasing the brightness of his game capture source for streaming purposes. This resulted in the TLOU loadremover not correctly identifying the Moth Screens™ 
+- ikeden had a filter for increasing the brightness of his game capture source for streaming purposes. This resulted in the TLOU loadremover not correctly identifying the Moth Screens™
 
 
 ## My Settings
 
 Settings that I use are layed out at their appropriate locations troughout the Setup section's steps.
 This was done to eliminate the need for this extra section.
 
-## Contributors blegasLove
+## Contributors [![blegasLove](https://static-cdn.jtvnw.net/emoticons/v2/303139860/default/dark/1.0)]()
 
 Though I'm the one building the configuration files I simply do not have the resources to test every scenario and every configuration.  I greatly appreciate when others report on problems so that I can make these tools better.  I view development on these tools as a community effort.
 
@@ -207,6 +204,7 @@ Though I'm the one building the configuration files I simply do not have the res
 - [charlatan_11235](https://www.twitch.tv/charlatan_11235) (Tested working function of PS4Share)
 - [leiberton](https://www.twitch.tv/leiberton) (Tested working function of PS4Share)
 - [Aquila_Ezio](https://www.twitch.tv/aquila_ezio) (Found success in newer software versions)
+- [JustSaft](https://www.twitch.tv/justsaft) (HZD load remover and GitHub repo optimizations and made a german load remover for HZD)
 
 #### TLOU2
 - [DemonicRobots](https://www.twitch.tv/demonicrobots) (Helped spearhead and test initial load remover)
@@ -223,8 +221,13 @@ Though I'm the one building the configuration files I simply do not have the res
 - [TimRoc](https://www.twitch.tv/timroc) ($30.00)
 - [PDub](https://www.twitch.tv/pdub) ($25.00)
 
-I am doing this purely to improve the quality of speedrunning these games and am completely happy to contribute to the respect communities.  Therefore I am providing these efforts for free for everyone and am thriled that people will better enjoy speed running the games.  I do not ask for donations.  I do not need monetary support to continue development on these tools.  Having said that, I do believe in patronage and am *very* grateful when others support my efforts.  I have also been asked by PDub to provide a method to support my efforts.  If you feel compelled to support then you may do so either through my Twitch or through the streamlabs donations links:
+I am doing this purely to improve the quality of speedrunning these games and am completely happy to contribute to the respect communities.  Therefore I am providing these efforts for free for everyone and am thriled that people will better enjoy speed running the games.  I do not ask for donations.  I do not need monetary support to continue development on these tools.  Having said that, I do believe in patronage and am **very** grateful when others support my efforts.  I have also been asked by PDub to provide a method to support my efforts.  If you feel compelled to support then you may do so either through my Twitch or through the streamlabs donations links:
 
  - [https://www.twitch.tv/blegas78](https://www.twitch.tv/blegas78)
  - [https://streamlabs.com/blegas78](https://streamlabs.com/blegas78)
 
+[![blegasHey](https://static-cdn.jtvnw.net/emoticons/v2/303139870/default/dark/1.0)]()
+[![blegasHype](https://static-cdn.jtvnw.net/emoticons/v2/303139854/default/dark/1.0)]()
+[![blegasLove](https://static-cdn.jtvnw.net/emoticons/v2/303139860/default/dark/1.0)]()
+[![blegasLurk](https://static-cdn.jtvnw.net/emoticons/v2/303139865/default/dark/1.0)]()
+[![blegasShock](https://static-cdn.jtvnw.net/emoticons/v2/302811435/default/dark/1.0)]()

readme-HZD.md

@@ -5,7 +5,7 @@ In this case, quite simply, a load is defined whenever "Loading..." is seen in t
 This includes few cut scene pauses in the beginning of Any% runs, as well as every time a fast travel is performed.
 This load remover checks the video feed for the "Loading...", and tells LiveSplit that it is a load whenever this appears.
 
-The latest load removers (.vas files) can be downloaded on the [Release Page here](https://github.com/blegas78/autoSplitters/releases)
+#### The latest load removers (`.vas` files) can be downloaded on the [`Releases Page`](https://github.com/blegas78/autoSplitters/releases)
 
 ## Testing
 
@@ -15,7 +15,6 @@ With all of the above up and running and showing IGT, try to start the timer and
 
 ## Variants & Scan Region settings (notice me senpai)
 
-
 ### Normal variant
 
 This is the best working, recommended variant for any runs on any platform.
@@ -29,14 +28,15 @@ This is the best working, recommended variant for any runs on any platform.
    - Height is set to 25
 
 
-### PC variant (memory based)*
+### PC (memory based) variants (Steam version only) *
 
-You should use this variant if on pc once development finishes.
+You should use this variant for any runs on PC once development finishes.
 
-> This should be available in LiveSplit itself soon™
+> If you still want to test this, the `.asl` file can be found in `src/HZD variants/pc`.
 
-###### If you still want to test this, the `.asl` file can be found in `src/HZD variants/pc` (Please report your feedback to JustSaft#9233 on Discord)
+Currently, this load remover only works with the [Steam](https://store.steampowered.com/app/1151640/Horizon_Zero_Dawn_Complete_Edition/) edition of the game.
 
+> The memory based LR should be available in LiveSplit itself once one `.asl` file works with the EGS, Steam and GOG edition of the game.
 
 ### PSShare variant
 
@@ -64,7 +64,7 @@ I added a classic variant where the scan region settings are the same as before
    - Set Height to 1080
 
 
-### Dev variant*
+### Dev variant *
 
 This variant was originally intended to see how small the WatchZone can be before loosing accuracy (the experiment was never finished ikedenS)