Merge branch 'master' of https://github.com/x0reaxeax/MWCrashFix

README.md

@@ -1 +1,25 @@
-# MWCrashFix
+# MWCrashFix
+
+### Description
+Fixes `Debug Error: R6025 - pure virtual function call` crash in Need for Speed Most Wanted 2005 1.3 BE.  
+
+A widely used fix for this crash is implemented in [@GrimMaple](https://github.com/GrimMaple)'s [mwfixes](https://github.com/GrimMaple/mwfixes) project,
+however, MWCrashFix (this mod) takes on a different approach for fixing this error, and that is by replacing the erroneous event with a different one, which should in theory not affect the spawn amount of pursuit events.  
+
+This mod **CAN be used** along with the [mwfixes](https://github.com/GrimMaple/mwfixes) project, however, the **'Roadblock spawn problem fix'** in mwfixes will become **obsolete**. 
+
+### Usage
+Copy `MWCrashFix.asi` to `scripts` folder, which is located inside the main `Need For Speed Most Wanted Black Edition` game folder.
+
+You can grab the compiled ASI file from the [Releases](https://github.com/x0reaxeax/MWCrashFix/releases) page, or compile it on your own.
+
+### Troubleshooting
+* `Instruction Check` error when starting the game:  
+  * You're using an unsupported version of NFS MW. This mod was made for v1.3 RELOADED patch only.
+
+
+### Additional information
+All instances of offending `MOV r/m32, imm32` instruction in `speed.exe`, where `imm32` is the erroneous address `0x00890970`, are replaced with a `MOV r/m32, 0x8aa828`, with `0x8aa828` being an address of a non-offending pursuit event.
+
+### Possible improvements
+* Add more non-offending event addresses to provide a variety in pursuit event spawning.