================================================================================
 JIMBO (J1mB0) CROSSHAIR REMAKE by TecHniCzny  —  version 1.0.0  —  World of Tanks 2.4.0.1
================================================================================

ABOUT THE MOD
-------------
A from-scratch, modern reconstruction of the iconic J1mB0's Crosshair, which
has not been developed for years (its author stopped after WoT 0.9.15.1).
I wrote the crosshair code myself to fit the current game and keep it light
on performance. It is built on top of the open-source Dispersion Reticle mod
by Pruszko (MIT licence), which provides the reticle framework.

Big thanks to everyone whose ideas inspired this project:
- J1mB0, for the original visual concept of the whole crosshair,
- KT, for the original idea of a vehicle HP indicator built into the
  crosshair (later modified by J1mB0),
- Dellux and koshnaranek, authors of the original "GunConstraints" add-on,
  whose concept inspired the turret traverse limit indicator,
- Pruszko, author of Dispersion Reticle, which this mod is built on.

WHAT IT DOES
------------
- REAL DISPERSION: the vanilla WoT circle is drawn about 1.7x bigger than
  the gun's actual dispersion (found by Jak_Attackka, StranikS_Scan and
  others). This mod scales it to the real size (factor 0.585), so the circle
  you see is where your shells can really go.
- TWO CIRCLES instead of one: the outer circle shows the full (real)
  dispersion, the inner circle (half the radius) shows the zone where most
  shots land. You can fire with confidence before the reticle has fully
  converged.
- RELOAD RING around the crosshair, in both arcade and sniper mode. It fills
  up while reloading and flashes when the gun is ready.
- GUN DEPRESSION / ELEVATION ARC below the crosshair. The dot shows how much
  gun angle you have left and turns amber, then red, near the limit.
- TURRET TRAVERSE ARC above the crosshair, shown only for vehicles with a
  limited traverse (TDs, casemates). Detected automatically from game data,
  so it covers every vehicle, including new ones.

The mod only uses information about YOUR OWN vehicle (dispersion, reload,
gun angle, HP). It shows nothing about enemies.

THREE VARIANTS
--------------
- v1 Classic   : faithful to the original — thin BLACK circles, a dot with
                 a light halo, no outline.
- v2 Full HUD  : white circles; in sniper mode a lens-shaped frame with two
                 bars (left = your HP, right = reload). DEFAULT.
- v3 Bold      : like v1 in shape, but thicker white lines for crowded
                 maps and high resolutions.

INSTALLATION
------------
1. REMOVE the original Dispersion Reticle if you have it:
   World_of_Tanks\mods\2.4.0.1\pruszko.dispersion_reticle_*.wotmod
   (both mods contain the same files, so they cannot run together).
2. Extract this archive into your World_of_Tanks folder, so that the "mods"
   folder from the archive merges with the game's "mods" folder.
   Allow overwriting files.
3. Start the game.

If your game version is different from 2.4.0.1, rename the folder
mods\2.4.0.1 to your version number (check the numbered folders in
World_of_Tanks\mods).

CHANGING THE VARIANT
--------------------
Copy the "mods" folder from optional_variants\<variant>\ into your
World_of_Tanks folder, overwriting the file. Then press CTRL+P in the
garage or in battle (reloads the config), or restart the game.

The variant is stored in its own file:
   World_of_Tanks\mods\configs\JimboCrosshairRemake\config.json
   "reticle-style": "classic" | "white" | "bold"
   "hud-style":     "arc" (rings only) | "j1mb0" (frame in sniper mode)

SIZE AND COLOUR
---------------
Size, colour and other reticle settings are in:
   World_of_Tanks\mods\configs\DispersionReticle\config.json
   (section "hybrid-reticle-extended")
You can also change them in the in-game mod settings menu if you have
ModsSettingsAPI installed. Saving there will not reset your variant.
In v1 Classic the lines are always black, like the original.
Prefer the vanilla (bigger) circle size? Set "reticle-size" -> "multiplier"
to 1.0 in the same file.

KNOWN LIMITATIONS
-----------------
- The large dashed green circle and the grid you may see are the vanilla
  WoT crosshair, not this mod. To hide them, go to Settings -> Crosshair
  (arcade and sniper) and set the opacity of the grid / dispersion
  elements to 0.
- Do not combine with mods that change reticle size or show a server
  marker (e.g. Better Reticle Size, AwfulTanker's Server Marker) or with
  other mods that replace Dispersion Reticle files.

AUTHOR AND CONTACT
------------------
Author: TecHniCzny (Twitch: 73chn1c)
Contact: https://twitch.tv/73chn1c

SUPPORT (DONATE)
----------------
This mod is, and always will be, free. If you appreciate the time I spent
rewriting it, you can buy me a coffee:
https://tipply.pl/@73chn1c

Licence: CC BY-NC-SA 4.0 (free to share and modify, non-commercial,
credit required). The Dispersion Reticle base stays MIT. See LICENSE.txt.
================================================================================
