===================================================================
                     PERSISTENCE REALISM v1.0.0
                            by Bloooey
===================================================================

[ DESCRIPTION ]
Persistence Realism creates a living world where your choices matter. 
Vehicles are saved exactly where you left them—including their damage, 
modifications, and dirt levels. If you crash a car and leave it on the 
highway, it stays there. To get it back in pristine condition, you must 
engage with the fully integrated Insurance System.

The mod also includes a robust Wardrobe system for saving outfits and 
a Location Manager to track your favorite spots on the map.

[ REQUIREMENTS ]
1. ScriptHookV
2. ScriptHookVDotNet (Latest Nightly recommended)
3. LemonUI (Required for the menus to function)

[ INSTALLATION ]
1. Ensure you have the requirements installed.
2. Extract the contents of the download.
3. PersistenceRealism folder into your GTA V `scripts` directory.
4. (Optional) Edit `PersistenceRealism.ini` to customize settings.
5. (optional) install the included handling and vehicles.meta files. 

[ DEFAULT CONTROLS ]
- Open Menu: Numpad 9 (configurable in .ini)


[ MOD SHOP CAMERA CONTROLS ]
- Rotate Camera: A / D
- Zoom: W / S
- Adjust Height: Ctrl / Shift
- Toggle First Person / Orbit View: V

===================================================================
                IMPORTANT: DEFORMATION NOTICE
===================================================================

Broken doors, windows, flat tires, and engine smoke/fire are saved 
without issues. However, vehicle deformation (dents) is much 
trickier. 

The only option for reapplying deformation is by essentially banging on 
the vehicle repeatedly with an imaginary hammer at the coordinates where 
damage was detected. This does an alright job of reapplying the 
same damage, however, it is an approximation. 

There is no option to directly copy dents from a saved vehicle to a 
vehicle in the world. Instead, we save where the vehicle is damaged, 
and then hit it in those spots on spawn—kind of like making a photocopy 
of the damages each time you spawn the car. Therefore:
* Areas with heavy damage may get worse on respawn.
* Areas with light damage may not appear damaged on respawn.

You can try changing the settings in the .ini file if you are not happy 
with the deformation results.

[ META FILE RECOMMENDATIONS ]
If some vehicles are deforming more or less than others, you may need 
to check the `vehicles.meta` and `handling.meta` for that car. The 
default settings included in this mod are based on the following values:

* vehicles.meta:
  - damageMapScale = 1.0
  - damageOffsetScale = 1.0

* handling.meta:
  - fDeformationDamageMult = 1.0
  - fCollisionDamageMult = 1.0

I have included a copy of each file with the values changed for all vehicles. 

===================================================================
                      WHAT IS PERSISTED?
===================================================================

The following data points are tracked and restored:

[ VEHICLE DATA ]
* Position & Orientation: Exact coordinates and heading.
* Visuals: Bumpers, spoilers, skirts, exhausts, and all body mods.
* Paint: Primary, Secondary, Pearlescent, and Wheel colors.
* Interior: Dashboard color, Interior Trim color, and Window Tint.
* Lighting: Neon layout (Left/Right/Front/Back), Neon color, and Xenon color.
* Performance: Engine, Brakes, Transmission, Suspension, Armor, and Turbo.
* Wheels: Rim type, Rim variation, Tire Smoke color, and Custom Tires.
* Identifiers: License plate text and License plate style (Blue/Yellow/etc.).
* Extras: Vehicle "Extras" toggles (roof racks, etc.).
* Radio: The last radio station currently playing is saved.

[ DAMAGE & STATE ]
* Deformation: Uses a spherical scan to save specific dent locations.
* Component Health: Exact Engine Health, Body Health, and Petrol Tank Health.
* Parts Status: Broken windows, missing doors, and detached/hanging bumpers.
* Tires: Bursted tires (specific wheels) and bulletproof tire status.
* Environment: Dirt level and paint fade/wear.

[ CHARACTER DATA ]
* Wardrobe: Saved outfits including all clothing components and props.
* NPC Sync: "Primary" outfits can appear on protagonists (Trevor/Michael/Franklin) when you encounter them as NPCs.

===================================================================
                      FEATURES OVERVIEW
===================================================================

1. INSURANCE SYSTEM
   - Purchase plans (Bronze, Silver, Gold, Platinum).
   - Weekly premiums are deducted from the specific character's cash.
   - "Anti-Repair" system prevents the game from magically fixing cars when you look away.

2. MOD SHOP
   - Access a full mod shop from the menu while inside a saved vehicle.
   - Real-time editing of performance and cosmetics.

3. LOCATION MANAGER
   - Save custom locations and waypoints.
   - Customize map blip icons and colors for saved spots.

[ CONFIGURATION ]
Check `PersistenceRealism.ini` to toggle the Damage System, Insurance 
System, or adjust map blip visibility modes.