Additional desync logging (#1098)

* Implement additional sync logging for RNG calls

* Log facing changes

* Log target changes

* Don't apply hook disabling patch more than once

* Log destination changes and fix errors with target change logging

* Fixup

* Log mission overrides and fix hook disable patches

* Log anim creation and refactor the sync log event buffer logic

* Add docs & credits

* Fix oopsie

CREDITS.md

@@ -204,6 +204,7 @@ This page lists all the individual contributions to the project by their author.
   - Chrono sparkle animation display customization and improvements
   - PipScale pip size & ammo pip frame customization
   - Extension class optimization
+  - Additional sync logging
 - **Morton (MortonPL)**:
   - `XDrawOffset` for animations
   - Shield passthrough & absorption

Phobos.vcxproj

@@ -155,6 +155,7 @@
     <ClCompile Include="src\Utilities\Patch.cpp" />
     <ClCompile Include="src\Utilities\AresHelper.cpp" />
     <ClCompile Include="src\Utilities\AresAddressTable.cpp" />
+    <ClCompile Include="src\Misc\SyncLogging.cpp" />
     <ClCompile Include="YRpp\StaticInits.cpp" />
   </ItemGroup>
   <ItemGroup>
@@ -181,6 +182,7 @@
     <ClInclude Include="src\Ext\CaptureManager\Body.h" />
     <ClInclude Include="src\Misc\FlyingStrings.h" />
     <ClInclude Include="src\Misc\PhobosToolTip.h" />
+    <ClInclude Include="src\Misc\SyncLogging.h" />
     <ClInclude Include="src\Misc\TypeConvertHelper.h" />
     <ClInclude Include="src\New\Type\DigitalDisplayTypeClass.h" />
     <ClInclude Include="src\New\Type\RadTypeClass.h" />

docs/Miscellanous.md

@@ -10,6 +10,7 @@ This page describes every change in Phobos that wasn't categorized into a proper
 - This feature must be enabled with `SkirmishUnlimitedColors=true` in `[General]` section of game rules.
 - When enabled, the game will treat color indices passed from spawner as indices for `[Colors]` section entries.
   - In example, with original rules, index 6 will correspond to color `Orange=25,230,255`.
+- Phobos writes additional information to the `SYNC#.txt` log files when a desynchronization occurs such as calls to random number generator functions, facing / target / destination changes etc.
 
 ```{note}
 This feature should only be used if you use a spawner/outside client (i.e. CNCNet client). Using it in the original YR launcher will produce undesireable effects.

docs/Whats-New.md

@@ -324,6 +324,7 @@ New:
 - Chrono sparkle animation display customization and improvements (by Starkku)
 - Script action to Chronoshift teams to enemy base (by Starkku)
 - PipScale pip size & ammo pip frame customization (by Starkku)
+- Additional sync logging in case of desync errors occuring (by Starkku)
 
 Vanilla fixes:
 - Allow AI to repair structures built from base nodes/trigger action 125/SW delivery in single player missions (by Trsdy)