pdComp v0.3.7 - Installation
============================

Dependencies
---------------------

Required:

- RAGE Plugin Hook
- LSPDFR
- A supported records integration - either:
    - Policing Redefined + Common Data Framework, or
    - Stop The Ped

pdComp reads ped and vehicle records from one of the integrations above, so at
least one must be installed. There is no standalone / vanilla mode; if neither
is found, pdComp logs the requirement and stops loading.

By default pdComp auto-detects which integration you have, preferring Policing
Redefined / Common Data Framework and falling back to Stop The Ped. To force a
specific one, edit the [Integration] section of:

Plugins\LSPDFR\pdComp\config.ini

[Integration]
Mode = Auto
WarrantReasonSource = CatalogFallback

   Auto - detect automatically (PR/CDF first, then Stop The Ped)
   Cdf  - require Policing Redefined / Common Data Framework
   Stp  - require Stop The Ped

WarrantReasonSource controls wanted/warrant reason text shown by pdComp:

   External        - use external CDF/LSPDFR/STP reason text and old fallback text
   CatalogFallback - use external reason text when present, otherwise pick from data\charges.json
   Catalog         - always pick from data\charges.json for wanted records when charges are loaded

pdComp does not include RagePluginHook.dll, CommonDataFramework.dll, or
StopThePed.dll. Install RAGE Plugin Hook, LSPDFR, and your chosen records
integration separately.

Newtonsoft.Json.dll is included in this archive under:

Optional Files\Newtonsoft.Json.dll

Most modded RAGE Plugin Hook installs already have Newtonsoft.Json.dll in the main GTA V
folder, next to GTA5.exe. If pdComp does not load or RAGE Plugin Hook reports a
missing Newtonsoft.Json/Newtonsoft.Json.dll error, check your main GTA V folder.
If Newtonsoft.Json.dll is not there, move or copy the file from Optional Files
into the main GTA V folder. Do not place it inside Plugins, LSPDFR, or scripts.

*OVERRIDING AN EXISTING NEWTONSOFT FILE PROVIDED BY ANOTHER PLUGIN MAY BREAK THAT PLUGIN*
use provided newtonsoft.json.dll only if your install does not already have it

Install
-------

1. Open this archive.
2. Drag the "Plugins" folder into your Grand Theft Auto V main folder.
3. Allow Windows to merge folders if prompted.
4. Start GTA V through RAGE Plugin Hook and go on duty in LSPDFR.

Archive layout:

pdComp archive
  Optional Files
    Newtonsoft.Json.dll
  Plugins
    LSPDFR
      pdComp.dll
      pdComp
        config.ini
        assets
        data

Correct install layout after the normal drag-and-drop step:

<GTA V folder>
  Plugins
    LSPDFR
      pdComp.dll
      pdComp
        config.ini
        assets
        data

Do not install pdComp into the GTA V "scripts" folder.


Third-party vehicle image assets
--------------------------------

Vehicle lookup thumbnails are resized from the RAGE Multiplayer Wiki Vehicles
page:

https://wiki.rage.mp/wiki/Vehicles

The wiki marks its content as available under Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 unless otherwise noted:

https://creativecommons.org/licenses/by-nc-sa/4.0/

Attribution: RAGE MP Wiki contributors. A copy of this notice is included at:

Plugins\LSPDFR\pdComp\assets\vehicles\ATTRIBUTION.txt

pdComp is distributed for free. Do not reuse these vehicle images in a
commercial build.


Opening pdComp
--------------

Default keyboard key: apostrophe / quote key (OpenKey = OemQuotes)
Default controller button: DPadLeft

By default, pdComp opens while you are on duty, sitting in a stationary
law-enforcement vehicle. The field tablet opens from the same keybind while
you are stationary on foot.


Optional Pause Setting
----------------------

Config file:

Plugins\LSPDFR\pdComp\config.ini

Setting:

PauseGameWhileComputerOpen = true
HideHudAndRadarWhileComputerOpen = true

Both settings default to true. pdComp freezes the world with RPH Game.IsPaused
while the computer is open and hides GTA's HUD/radar while the computer is open.

Set PauseGameWhileComputerOpen to false only if you are troubleshooting pause
compatibility. In that mode, GTA controls are still suppressed each frame, but
other plugins may still see their own raw keybinds. Set
HideHudAndRadarWhileComputerOpen to false if you want the minimap to remain
visible while pdComp is open.

Evidence and Clear Call Data
----------------------------

When Policing Redefined is installed, pdComp can read evidence found through PR
searches. To attach evidence to an arrest report, bag it at your patrol vehicle
trunk first. Drug and firearm evidence must also be tested at the trunk before
it can influence court results.

Use Clear Call Data when you are done with a stop/call. It clears collected IDs,
tagged plates, active subject data, mugshots, and remaining bagged evidence
without deleting saved citations, arrest reports, or court cases.


Features
--------

pdComp includes:

- A simulated desktop MDT with draggable, resizable, snapping windows, plus a
  separate on-foot field tablet with a stock GTA tablet hold animation.
- Ped and vehicle lookup with live mugshots, citations, arrest reports, a
  Report Center (incident / use-of-force / vehicle-damage / death), a court
  docket with simulated hearings, and persistent JSON-backed history.
- Report Center death reports for homicide, fatal collision, and fatal
  officer-involved shooting documentation, with uncapped long-form report text.
- Deterministic report review feedback from supervisors, detectives, and fleet
  reviewers, with persistent review notes and varied response text on filed
  reports.
- Citation submit plays the ticket print sound, queues the citation in PR, and
  flags Stop The Ped for its own ticket handoff flow when available.
- Native LSPDFR police-computer lookup compatibility for ped searches, including
  the stock Arrest Warrant callout.
- Charge and citation category headers follow their first-seen order in the
  JSON catalogs, so numbered custom sections stay in the author's sequence.
- Charge and citation catalog font size can be tuned from Settings or
  [Appearance] CatalogFontScale in config.ini.
- Records pulled from Policing Redefined / Common Data Framework or Stop The Ped,
  depending on which integration you run.
- With Policing Redefined installed: PR ped radio checks, vehicle stops, and
  on-foot traffic stops feed the lookups and call timeline; arrests sync both
  ways, and an optional transport choice on the arrest form can request a PR
  prisoner transport unit at submit (nothing dispatches unless selected); and
  ALPR/BOLO hits can be read out by PR dispatch
  ([Integration] PrDispatchAudioOnBoloHit).
- Persistent vehicle BOLOs with ALPR-style hit notifications and cross-session
  recovery for matching vehicles.
- A lightweight ALPR plate reader and a speed radar with an on-screen readout.
  Both start switched off - toggle them in-game (default ALPR = F8, radar =
  Ctrl+I) or tune them under the [ALPR] and [Radar] sections of config.ini.
- Native LSPDFR callout tracking feeds the Callouts window and report context;
  optional Callout Interface data can enrich matching calls with ped/plate
  checks, ALPR source flags, messages, priority, and agency.
- Persistent dark mode, UI sounds with alert cues, configurable officer name and
  callsign, and customizable desktop wallpaper, bezel, and icons.
- v0.3.7 is a hotfix that applies top-level custom arrest charge courtWeight
  values during court outcome weighting.
- v0.3.6 adds support for tracking multiple counts of the same citation or
  arrest charge, now with a clearer QTY stepper in both catalogs, expands the
  charge and citation database with dozens of new offenses, and redesigns the
  Ped and Vehicle Lookup pages so key details stand out at a glance. Ped Lookup
  now highlights officer safety warnings and subject history right in the
  profile while keeping juvenile status as a subject-type note, and the Settings
  page is fully revamped on both laptop and tablet with search, organized
  categories, and an option to disable the on-foot field tablet. It also expands
  localization coverage, improves the tablet history view, hardens startup and
  dependency checks, fixes a Traffic Control tab crash while paused, tightens
  internal cleanup, and makes repeated arrest charges sentence consistently.
- v0.3.5 fixes Cyrillic and other non-ANSI UI text rendering with a cached
  Unicode bitmap fallback, and can load Cyrillic localization and charge /
  citation catalogs saved as Windows-1251 by older editors.
- v0.3.4 retunes court sentencing realism, deepens the STP evidence loop with
  field drug testing, adds print previews before filing, expands vehicle photos,
  simplifies arrest narrative drafting, and streamlines report writing:
  multi-select charge catalogs for citations and arrests, an evidence
  link-to-charge picker, drafts that survive page switches, and confirm-guarded
  reset buttons. It also restores the wide main pdComp logo on the desktop
  Start button and tablet header, fixes desktop vehicle owner status labels
  clipping to "st", and trims duplicate attribution text from this README.

Nearly everything is configurable in the compact config.ini file.
