﻿TankCoach - one-click installer
===============================

What it is
  A small program that installs (and later updates) the TankCoach mods for
  World of Tanks (Wargaming) or Mir Tankov (Lesta). Everything it does is
  printed in the window and saved to TankCoach_install.log. (The Russian
  version of these notes is README_INSTALL_RU.txt; the short version is START_HERE.txt.)

Install
  1. Close the game.
  2. Unzip the whole archive (don't run the installer from inside the zip viewer).
  3. Double-click  TankCoach_install.bat
     Windows may say "The publisher could not be verified" or "Windows protected
     your PC". That is normal for a program without a paid publisher certificate.
     Click "More info" -> "Run anyway" (or just "Run"). It is safe: the installer
     only installs kits carrying the author's digital signature (checked inside),
     and the installer's own fingerprints are published on Telegram (t.me/tankcoach).
  4. If you have more than one game, type the number of yours and press Enter.
  5. At the end you get a SUMMARY: what was installed, where, and where the
     backup is. Start the game.

Update
  Just run TankCoach_install.bat again. If a newer version of the mods is out,
  it downloads and installs it. If you are already up to date, it says
  "You have the latest version".

The game got a patch and the mods stopped working?
  Run TankCoach_install.bat. If the mods are ready for the new patch, they go
  into the new folder by themselves. If it says "The mod is not ready for this
  game patch yet. Please check back later", we haven't finished the update yet.
  Try again in a day or two.
  Since 1.4: if your client is NEWER than the kit but has the same major number
  (kit for 1.45, game already 1.46), the installer shows a big warning
  "version mismatch, errors are possible" and offers to install anyway - type
  YES (or ДА) to agree. The mods barely touch the game UI and usually survive
  such a patch; at worst a mod just stays silent. The install is marked as
  "forced" (in the log and in TankCoach_backup\installed.json); when a kit for
  your client is out, just run the installer again - it installs it as a
  normal update. No questions asked (advanced): TankCoach_install.bat -AllowNewerClient

The installer can't find the game
  Drag the GAME FOLDER (the one with WorldOfTanks.exe or Tanki.exe) onto the
  TankCoach_install.bat icon. Or drag the folder into the open window and
  press Enter.

Your own kit instead of downloading / no internet?
  Put the kit zip (TankCoach_tester_...zip) AND the signature file with the
  same name (TankCoach_tester_....sig) next to TankCoach_install.bat and run
  it. Since 1.3 such a kit is used FIRST and the server is not asked; the window
  says "Using local kit". A kit without a .sig file, or with a wrong signature,
  is NOT installed (and nothing is changed). If the kit next to the installer
  doesn't fit your game or patch, the installer asks the server instead.
  To force offline mode:  TankCoach_install.bat -Offline

Signature check (protection against tampering)
  Every kit is signed by the author. Before installing, the installer checks
  the kit's SHA-256 and signature against the key built into it (the key id is
  printed at the top of the window). If you see "Signature does not match - not
  installing, please report this to the author", NOTHING is installed. Don't try
  to get around it: download the installer again from the official page and
  send TankCoach_install.log to the author. The SHA-256 of the installer itself
  is published by the author on Telegram (t.me/tankcoach) and GitHub - compare
  it if you have any doubt (PowerShell:  Get-FileHash .\TankCoach_install.ps1).

What it does NOT do
  * It deletes nothing.
  * It doesn't touch other mods, your Netprobe_mod_result folder, or your
    nickname and key (coach_viewer.json, netprobe_track_config.json).
  * Before replacing anything it copies the old files of our mods to
    <game folder>\TankCoach_backup\<date-time>\ so you can put them back.
  * It sends nothing to the internet (it only downloads the kit from
    app.tankcoach.net or ru.tankcoach.net).
  * It doesn't need administrator rights.
  If the game is installed in Program Files and you get a "no permission"
  message, right-click the .bat and choose "Run as administrator".

Language of the window
  The installer uses the language of your Windows: Russian Windows - Russian,
  anything else - English. If it can't tell, it prints both.
  To force a language:  TankCoach_install.bat -Lang en   (or  ru,  or  both)

Something went wrong?
  Send TankCoach_install.log (it sits next to the .bat) to the author:
  VasiliyM, t.me/tankcoach.
