﻿TankCoach — tester kit, World of Tanks (Wargaming)                2026-10-14
==============================================================================
Author: VasiliyM · Telegram: t.me/tankcoach · Privacy: privacy@tankcoach.net
Language: EN (Russian version: README_RU.txt)


1. WHAT THIS IS
---------------
Three mods. Together they give you a battle breakdown on the project server
(https://app.tankcoach.net):

  mod_netprobe_wot.pyc       7.00   connection and shot recorder (netprobe, the "client")
  mod_netprobe_track.pyc     2.26   battle logger: positions, spotting, shots,
                                    hits, damage, armor
  mod_coach_viewer.pyc       0.29   TankCoach page: battle list, "Build"
                                    button, upload, key login

How it works:
  * In battle the mods SILENTLY write battle data to files (the
    Netprobe_mod_result folder next to the game). Nothing is sent by itself,
    nothing is analysed on your PC.
  * When you press "Build", the TankCoach page packs the files of THAT battle
    and uploads them to our server. The SERVER builds the report and serves
    it. All you need is a browser.
  * In battle you only get the netprobe indicator: a connection bar (ping,
    lag spikes) and, for a few seconds after each shot, the client and server
    reticle circles plus the point where the shell went. Hit or miss, who you
    hit and for how much are NOT shown or computed in battle; that is all in the
    report afterwards.
  * The mods only read what the client already knows; they do not control the
    game.


2. WHAT YOU NEED
----------------
  * World of Tanks (Wargaming), client version 2.4.1.0 (the kit is built for it).
  * A tester key and nickname — the author gives you the key (see 6).
  * A browser on your PC (Chrome, Edge, Firefox) to view the reports.
  * In the game settings turn on the "server reticle" — without it half of
    the measurements are lost.


3. INSTALL
----------
1) Close the game.
2) Find the game folder — the one with WorldOfTanks.exe in it. The launcher usually has
   a "show in folder" item (gear next to the Play button); or browse to the
   install path by hand.
3) Open version.xml in that folder (Notepad). Find the line
   <version> v.2.4.1.0 #… </version> and remember the number: 2.4.1.0.
4) Unzip the kit. Copy the folder  install\res_mods\2.4.1.0  into
   <game folder>\res_mods\  (overwrite if asked). You should end up with:

     res_mods\2.4.1.0\scripts\client\gui\mods\mod_netprobe_track.pyc
     res_mods\2.4.1.0\scripts\client\gui\mods\mod_netprobe_wot.pyc
     res_mods\2.4.1.0\scripts\client\gui\mods\mod_coach_viewer.pyc
     res_mods\2.4.1.0\gui\maps\netprobe\*.png            (68 images)

   IMPORTANT: the path must be ...\scripts\client\gui\mods\ — otherwise the
   mods silently don't load. This is the #1 mistake.
5) If you have other versions of these mods (mod_netprobe*.pyc,
   mod_netprobe_track.pyc, mod_coach_viewer.pyc) replace or remove the old
   files. Never run two versions of the same mod.
6) Launch the game. Check: after a minute the Netprobe_mod_result folder should
   contain log files (see 11).


4. AFTER A GAME PATCH
---------------------
Every patch makes a NEW numbered folder in res_mods, and your mods stay in the
old one. So:
1) Open version.xml -> the new number (e.g. v.<new number>).
2) Copy your old res_mods\2.4.1.0 folder to res_mods\<new number> (the
   whole thing: scripts and gui), or take install\res_mods\2.4.1.0 from
   the kit, rename it to the new number and copy it into res_mods\.
3) Launch the game. If the mods didn't load after the patch (no lines in the
   logs from 11), the client may have changed; tell the author your client
   version.
You can leave the old folder: the game only reads the folder of its own
version. A new kit from the author goes in the same way as in 3 (overwrite).


5. UNINSTALL
------------
Close the game. Delete the three files (mod_netprobe_track.pyc, mod_netprobe_wot.pyc,
mod_coach_viewer.pyc) from res_mods\2.4.1.0\scripts\client\gui\mods\ and
the folder res_mods\2.4.1.0\gui\maps\netprobe\ . The Netprobe_mod_result
folder (your battle files) can be deleted or kept; netprobe_track_config.json
in the game folder can go too.


6. FIRST RUN: OPEN THE PAGE AND LOG IN
--------------------------------------
Open the TankCoach page — press Ctrl+Shift+R in the garage.

 The page opens in your normal Windows browser (Chrome / Edge / Firefox —
 whichever is your default). The game stays open; Alt+Tab back to it.
 (Before 0.29 the page opened in the game's built-in browser — to get that
 back, put "mode": "overlay" into Netprobe_mod_result\coach_viewer.json.)

 If the browser did not open by itself:
      1. Alt+Tab -> open a normal browser (Chrome / Edge / Firefox).
      3. Type the address:   http://127.0.0.1:18765/server
         (bookmark it). 127.0.0.1 is YOUR computer: the mod serves the page
         while the game is running. Outside the game the page won't open.
      4. If it doesn't open, the port may have shifted (18766 … 18774). The exact
         address is in Netprobe_mod_result\coach_viewer.log, the line
         "server: http://127.0.0.1:…/".
    Then it's the same as usual: login, battle list, "Build". The report opens
    in the same browser tab — nothing else to do.


Login: the page asks for a nickname and a key.
  * Nickname = your in-game nick, key = the one the author (VasiliyM) gave you.
  * Enter once — the mod remembers it (stored on your PC in coach_viewer.json).
  * To change the key to your own: the "change the key to your own" link on the
    login box, or https://app.tankcoach.net/key
  * Page language: RU / EN switch at the top.
  * A battle played under a different nickname is rejected by the server.


7. HOW TO GET A BATTLE REPORT
-----------------------------
1) Play a battle and wait until you are back in the garage — ideally watch it
   through to the results screen: the server doesn't accept a battle without
   results (if the game crashed after the battle it takes it about 20 minutes
   after the battle start).
2) Open the TankCoach page (6). Press "Build" next to the battle.
3) The page packs the battle files, uploads them, and in a few seconds
   (sometimes a minute or two if the server is busy with someone else's battle)
   the report opens. Afterwards the battle shows "Open" in the list.
4) In the report: "⤓ Download" saves the report as a file, "🔗 Link" copies the
   address, "↗ Open in browser" opens the report in your normal Windows
   browser (needed if the report opened inside the game's built-in window;
   coach_viewer 0.27+). A report link opens anywhere, no mod needed.
5) To close the in-game window with the report — Esc or "✕ Close".

The "np: …" tag on a battle: "raw" = connection data present, all good;
"unfinished" = the game closed mid-battle (the report builds without the shot
breakdown); "none" = no connection data (e.g. netprobe didn't load).


8. WHAT GETS SENT TO THE SERVER
-------------------------------
  * AUTOMATICALLY: only errors of our mods (from the mod logs and python.log,
    only lines of our mods), without other players' nicknames. Sent by the
    TankCoach page while it's open. Turn off: "report a problem / idea" ->
    untick "send mod errors automatically".
  * ON "Build": the files of that one battle — vehicle positions and headings,
    spotting, shots, hits, damage, armor, connection data, the battle results
    and the battle roster (the participants, as in the results screen).
  * ONLY IF YOU TICK IT in the "report a problem" box: tails of the mod logs
    (your Windows user name in paths is replaced by <user>; you can preview what
    goes — "what will be sent?") and up to 3 screenshots from the game's
    screenshots folder that you pick yourself.
  * The mods themselves never send anything to the internet — the TankCoach
    page in your browser does, and only under these rules.


9. PRIVACY
----------
  * The developer sees testers' battle reports — to find bugs and improve the
    service.
  * The developer (VasiliyM) has admin access to the server: he can see the
    list of all testers' battles, their reports, feedback and build failures.
    Views are recorded in the server's audit log.
  * Data is not shared with third parties.
  * Nicknames are not stored in analytics. (The battle files themselves contain
    the battle roster, like the results screen — it is needed to build the
    report; nicknames do not go into summaries or statistics.)
  * To delete your data write to privacy@tankcoach.net (give your nick and the
    battle dates if you only want part of it removed).
  * What we collect, on the site: tankcoach.net/en/privacy/


10. FEEDBACK AND PROBLEMS
-------------------------
  * TankCoach page -> "✉ report a problem / idea" (and the ✉ next to every
    battle), and the "✉ Report a problem" button in every report. Pick
    problem / idea / other, write a few words. The battle, mod versions, client
    and language are attached automatically.
  * Logs and screenshots only if you tick the box (see 8). If unsure — don't.
  * Under verdicts in the report there may be "correct / wrong" buttons — they
    help us check the breakdown; click them when you really mean it.
  * Or just message on Telegram: t.me/tankcoach.
  * Most useful: "in this battle at shot #N the report says …, but actually …"
    + the report address.


11. IF IT DOESN'T WORK
----------------------
Open the Netprobe_mod_result folder (next to the game). The logs should have:
  netprobe_track.log   "netprobe_track 2.26 by VasiliyM loaded"
  netprobe.log         "netprobe 7.00 by VasiliyM loaded"
  coach_viewer.log     "coach_viewer 0.29 zagruzhen"
No line -> the mod didn't load: check the path from 3 (the usual culprit is an
extra or missing folder) and the version folder number (4). Still nothing — send
these three logs to the author.
  * The page doesn't open — see 6. The page says "server unavailable" — the
    project server runs on the author's own hardware and has downtime: the
    battle is NOT lost (files stay on your PC), press "Build" later.
  * Daily upload limit — the page says "limit reached"; wait until tomorrow.
  * Lots of mod errors in python.log — send python.log from the game folder.


12. KNOWN LIMITATIONS (this is a test build)
--------------------------------------------
  * The "covered below N m" band (obstacles on the line of fire) is coarse:
    side cover is not seen, it is an estimate from terrain and silhouette, and
    closer than ~7 m there is no target silhouette. Don't treat it as exact.
  * Some report parts are still in development: the shot "Breakdown"
    (animation), armor/pen zones, the 3D view, analysis of hits on you. Things may
    be empty, approximate ("estimate") or differ from what you saw.
  * The client doesn't send the random pen roll — the report shows the
    boundary ("pen if the roll was at least …"), not the roll itself. HE and
    splash are estimates.
  * 3D (WebGL) needs GPU in the browser: fine in an external browser; in the
    built-in window of a stock client it may not work (you get a flat picture).
  * WG: the stock client is still being tested with our page — if something
    looks off in the built-in window, open the same thing in an external
    browser and tell us what differs.
  * A report takes from seconds to a few minutes (server queue).
  * The server is single and small: if you upload dozens of battles in a row
    some will queue. Send real battles, not your whole archive.
  * Watching a replay is not a battle; build reports from real battles.


by VasiliyM · t.me/tankcoach
