Skip to content

Commit

Permalink
docs: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MeSoftHorny committed Jun 30, 2024
1 parent 72af014 commit 0d9d114
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can enable it at: **Settings -> General tab -> Auto-load profiles**

Profiles have loading priorities:
1. Vehicle Profiles.
2. By a Type: Flighter, Strike, etc.
2. By a Type: Fighter, Strike, etc.
3. By a Propulsion: Prop, Jet.
This means that if you have a vehicle profile, it will be loaded first, ignoring other types.

Expand Down Expand Up @@ -305,7 +305,7 @@ Examples:
#### "Lua-script" option
Allows you write a custom value processing in Lua.
Right after enabling this option and pressing OK, a template script will be created, you can find it at:
**`Indicators/NAME/update.lua`**
**`Indicators/<NAME>/update.lua`**

Also have a look at the [Lua API](lua-api.md) to see all the functions that are available.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
## Features
- **Cross-platform**: Windows, Linux and macOS.
- More than 30 types of indicators (Climb, AoA, Turning time, Turning radius, Fuel consumption, WEP remain, Booster remain, etc.).
> **Note:** **Weapon** or **Ammo** information **is not** available (or very limited) in the web-map, so it cannot be added to the app.
**Note:** **Weapon** or **Ammo** information **is not** available (or very limited) in the web-map, so it cannot be added to the app.
- Two types of OSD (On-screen display):
- **WTRTI** - Built-in OSD. See [OSD Setup](features.md#wtrti-built-in).
- **RTSS** - using "RivaTuner Statistics Server" OSD functionality.
Expand Down Expand Up @@ -40,10 +40,10 @@ WTRTI does **not** make any changes to the game process or its data, it 'only' t
> **Note**: Make sure it is not in the game root directory, otherwise the game launcher will delete the WTRTI executable.
3. Start WTRTI.
4. Add some indicators to the list (**+** button).
5. Start the game and switch to the "Fullscreen Window" mode in the Graphics settings.
5. Start the game and switch to the "**Fullscreen Window**" mode in the **Graphics** settings.
6. Go to "Test Flight".

### Upgrade from previous versions
### Upgrade from old versions
Simply extract the downloaded zip file into the folder where the old version is located.

## System requirements
Expand All @@ -53,7 +53,7 @@ Simply extract the downloaded zip file into the folder where the old version is
**Windows**: 7 or higher.
**Linux**: Ubuntu 20.04 and later. X11 only.
*The Overlay requires Compositor (eg. kwin, compiz).*
*Since v2.2.5, you can use __Gamescope (v3.11.0+)__, See [How-To](features.md/#gamescope-setup-linux).*
*Recomended to use __Gamescope__(v3.11.0+) for better performance. See [How-To](features.md/#gamescope-setup-linux).*
**macOS**: 11.0 and later.
- **Graphics**:
Buit-in OSD: Any OpenGL 3.3 compatible GPU.
Expand Down
19 changes: 12 additions & 7 deletions docs/docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## The overlay is stuttering/freezing or Data is not updating when ALT-TAB to the game
Try to turn off the "Hardware Accelerated GPU Scheduling":
<https://www.thenerdmag.com/how-to-turn-off-hardware-accelerated-gpu-scheduling-on-windows-10/>
Try to turn off the "Hardware Accelerated GPU Scheduling" (HAGS).
**How-To:** <https://obsproject.com/kb/hags>

## Not working with DEV server
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.
In this case, try enabling "Handle data in every game mode" (Settings -> Advanced tab).
WTRTI may not work if a vehicle does **not** have a cockpit or the game client is **Minimal**, causing some information(**indicators.json**) to be missing on localhost:8111.
In this case, you can try enabling **"Handle data in every game mode"** (**Settings -> Advanced tab**).
!!! info
Some indicators may not work due to the limited amount of data available from the localhost:8111, e.g. Critical AoA, Critical Air Speed.
!!! warning
Expand All @@ -18,6 +18,7 @@ RTSS may conflict with other overlays, try disabling them first.
If you running the game through Steam, try to disable Steam Overlay for War Thunder, just open Properties->General-> Uncheck the "Enable the Steam Overlay while in-game".

## WTRTI OSD: transparency is not working/black rectangle
First try to restart your PC.
**Windows:** The Compositor on your system is not working properly.
Can be a few things:
- Graphics driver issue, try to reinstall.
Expand All @@ -27,7 +28,11 @@ Can be a few things:
## Flight data is not being written to the CSV file
Perhaps Antivirus restricts write access, try to add exclusion for WTRTI.

## Fuel consumption indicators not working
The "fuel" value in localhost:8111 (web-map) is missing on some aircraft (e.g. some early Yak's).
Before **bug-report**, check for the "fuel" in "State"" window (press F2 in the main window), while you in Test Flight.
## Fuel consumption indicators not working
The "fuel" value in the localhost:8111 (web-map) is missing on some aircraft (e.g. some early Yak's).

_Before bug-report to me, check for the "**fuel**" in the "State" window (press F2 in the main window), while you in "Test Flight"._

## Radar Altitude does not work
The "**radio_altitude**" value in the localhost:8111 may be missing on some aircraft, because the aircraft does not have a radar altitude or the value is displayed on a digital device (modern jets).

0 comments on commit 0d9d114

Please sign in to comment.