Note: This hook already exists within BeardLib. However, if the custom heist you've download uses the old format (under /mods, instead of /Maps), you'll need this hook in order to get those heists running in Crime Spree aswell.
Can also be used to add original heists to the Crime Spree pool that aren't in yet, like Jewerly store, Nightclub & Mallcrasher, which are heists this mod adds aswell.
However, if you don't need any of these things, there's no point in downloading this mod.
This is a hook made for people who create custom heists. It allows them to add their heist to the Crime Spree selection pool using just a single function, which can be appended as a hook in the main.xml.
Next to this, this hook will also add jewerly store, mallcrasher and nightclub to the Crime Spree pool.
The zip file contains not only the hook, but also an example on how to use it and information for modders on how to append it onto their custom heists for people to use. The example is well-documented, showing off parameters, parameter types, descriptions and details which may or may not be important to you as modder.
Note: The map modder must use the hook in order for it to be added to the Crime Spree pool! This mod will not automatically detect and add heists to the pool in any way! If you want a custom heist in your Crime Spree pool, but it's not in there, ask the map modder responsible to add it onto the pool!
The *.zip file should be extracted and placed under /mods. - Be careful that, once extracted, your files aren't inside another folder, but directly into the folder closest to /mods.
For example, you do not want this: /mods/CustomCrimeSpreeContract/CustomCrimeSpreeContract/<files here>.
Instead, you want this: /mods/CustomCrimeSpreeContract/<files here>.
You need this if you want custom heists to be added onto your game. This mod is completely optional however, in that, even though the map itself may attempt to add onto the crime spree pool, it will not happen, unless you've got this mod installed.
WARNING: IF YOU HAVE A CRIME SPREE ACTIVE AND YOU REMOVE THIS MOD, YOU CAN NO LONGER START YOUR CRIME SPREE UNTIL YOU RE-INSTALL THE MOD. THE SAME APPLIES TO WHEN YOU REMOVE A CUSTOM HEIST FROM YOUR MODS, BUT IT WAS AVAILABLE IN YOUR CRIME SPREE POOL AT THE TIME OF STARTING THE SPREE.
It is recommended to clear any crime sprees that might be going on before installing this mod, but you aren't required to do so.
In case you've gotten into a situation where your game crashes immediatly after you select "Accept" under Crime Spree, there is a file included to help you solve the issue. It will clear your Crime Spree completely and will remove all your progress - The instruction are included within the file, on how to get this working.
As always: Have a great day and happy custom heisting! :)
