Skip to content

Commit d412030

Browse files
authored
Update README.md
1 parent 03e5e71 commit d412030

File tree

1 file changed

+20
-33
lines changed

1 file changed

+20
-33
lines changed

README.md

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,11 @@
1616
</p>
1717
<h1 align="center"></h1>
1818

19-
**WarThunder Real-Time Information**, a highly customizable HUD overlay and logging tool for War Thunder.
20-
21-
<h1 align="center"></h1>
22-
23-
### Features:
24-
- More than 30 types of indicators (Climb, AoA, Turning time, Turning radius, Fuel consumption, WEP remain, Booster remain, etc.).
19+
**WarThunder Real-Time Information**, a highly customizable HUD overlay and logging tool for War Thunder.
20+
21+
## Features
22+
- More than 30 types of indicators (Climb, AoA, Turning time, Turning radius, Fuel consumption, WEP remain, Booster remain, etc.).
23+
Note: Ammo related information is not available (or very limited) on the web-map, so it cannot be added to the app.
2524
- Two types of OSD (On-screen display):
2625
RTSS - using "RivaTuner Statistics Server" OSD functionality. Works with any window mode.
2726
WTRTI - Borderless window with transparency. *Requires "Fullscreen Window" mode to be enabled.*
@@ -34,64 +33,52 @@
3433
- "Game chat" window, with ability translate in-game chat messages by opening Google Translate web-page or in-app translate (Lingva.ml).
3534
- "Battle Log" window, with a keyword highlight.
3635

37-
38-
<h1 align="center"></h1>
39-
40-
### How it works:
36+
## How it works
4137
WTRTI does not make any changes to the game process or its data, it 'only' processes data from localhost:8111(web-map) and displays it on a screen.
4238

43-
<h1 align="center"></h1>
44-
45-
### Installation:
39+
## Installation
4640
1. Download [the latest version](https://github.com/MeSoftHorny/WTRTI/releases)
4741
2. Extract it to a seperate folder with write permissions. Make sure it is not in the game root directory, otherwise the game launcher will delete WTRTI.exe file in there.
4842
3. Run WTRTI.exe.
4943

50-
51-
### Upgrade from previous versions:
44+
### Upgrade from previous versions
5245
Simply extract the downloaded zip file into the folder where the old version is located.
46+
5347

54-
55-
<h1 align="center"></h1>
56-
57-
### System requirements:
58-
48+
## System requirements
5949
- Game: Full client+
6050
*DEV Server or Minimal client users, see Troubleshooting section for a workaround.*
61-
- OS: Windows: 7 or higher
51+
- OS: Windows 7 or higher
6252
Linux: Ubuntu 20.04 and later
6353
*Borderless window mode requires Compositor to be enabled.*
6454
- Graphics: Any OpenGL 3.3 compatible GPU or greater
6555
*RTSS OSD: Rivatuner Statistics Server v7.3+. [Download](https://www.guru3d.com/files-details/rtss-rivatuner-statistics-server-download.html)*
6656
- VR: SteamVR
6757

68-
<h1 align="center"></h1>
69-
70-
### Troubleshooting:
58+
## Troubleshooting
7159
_**"Not working with DEV server":**_
72-
WTRTI may not work, if the vehicle does not have a cockpit or the game client is Minimal, which causes the indicators.json file to be missing on localhost:8111.
60+
&nbsp;&nbsp;&nbsp;&nbsp;WTRTI may not work, if the vehicle does not have a cockpit or the game client is Minimal, which causes the indicators.json file to be missing on localhost:8111.
7361
In this case, try enabling "Handle data in every game mode" (Settings -> Advanced tab).
74-
Beware: Some of the indicators will not work (e.g Critical AoA, Wing Flutter), due to the limited amount of data available from localhost:8111.
62+
Note: Some of the indicators will not work (e.g Critical AoA, Wing Flutter), due to the limited amount of data available from localhost:8111.
7563

7664
_**"OSD is not show up" or "Data is not updated in the main window":**_
77-
If you have Antivirus, try to add exclusion for WTRTI.
65+
&nbsp;&nbsp;&nbsp;&nbsp;If you have Antivirus, try to add exclusion for WTRTI.
7866

7967
_**"The overlay is stuttering/freezing" or "Data is not updating when ALT-TAB to the game":**_
80-
Try to turn off the "Hardware Accelerated GPU Scheduling": https://www.thenerdmag.com/how-to-turn-off-hardware-accelerated-gpu-scheduling-on-windows-10/
68+
&nbsp;&nbsp;&nbsp;&nbsp;Try to turn off the "Hardware Accelerated GPU Scheduling": https://www.thenerdmag.com/how-to-turn-off-hardware-accelerated-gpu-scheduling-on-windows-10/
8169

8270
_**"RTSS OSD is not working":**_
83-
RTSS may conflict with other overlays, try disabling them first.
71+
&nbsp;&nbsp;&nbsp;&nbsp;RTSS may conflict with other overlays, try disabling them first.
8472
If you running the game through Steam, you can disable overlay for War Thunder, just open Properties->General-> Uncheck the "Enable the Steam Overlay while in-game"
85-
8673

8774
_**"WTRTI OSD: transparency is not working/black rectangle":**_
88-
Windows: The Compositor on your system is not working properly. Can be a few things:
75+
&nbsp;&nbsp;&nbsp;&nbsp;**Windows:** The Compositor on your system is not working properly. Can be a few things:
8976
1. Graphics driver issue, try to reinstall.
9077
2. Windows is corrupted (sfc /scannow).
91-
Linux: Try to enable the compositor (kwin, compiz, picom).
78+
**Linux:** Try to enable the compositor (kwin, compiz, picom).
9279

9380
_**"Flight data is not being written to the CSV file":**_
94-
Perhaps Antivirus restricts write access, try to add exclusion for WTRTI.
81+
&nbsp;&nbsp;&nbsp;&nbsp;Perhaps Antivirus restricts write access, try to add exclusion for WTRTI.
9582

9683
<h1 align="center"></h1>
9784

0 commit comments

Comments
 (0)