Skip to content

Commit

Permalink
docs: - Add some notes and warnings
Browse files Browse the repository at this point in the history
      - Cleanup
  • Loading branch information
MeSoftHorny committed Dec 19, 2023
1 parent 1bc23c7 commit 7e1c5d5
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 42 deletions.
84 changes: 55 additions & 29 deletions docs/docs/features.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
## OSD Setup
### WTRTI (Built-in)

Enabled by default. Otherwise, **Settings -> OSD -> OSD Type -> WTRTI**
This type of OSD is enabled by default, if it is not, you can enable it at:
**Settings -> OSD -> OSD Type -> WTRTI**

In the game switch to **Fullscreen window**
Start the game. In the graphics settings, switch to **Fullscreen window** mode.

![#](images/wt_fullscreen_mode.png)

To change the font, see [Changing the fonts](features.md/#wtrti).
That's it. Go to the "Test Flight" for testing.


!!! tip
To change the font, see [Changing the fonts](features.md/#wtrti).
!!! warning
Make sure that **"Hardware Accelerated GPU Scheduling" (HAGS)** is **disabled**.
See [Troubleshooting section](troubleshooting.md#the-overlay-is-stutteringfreezing-or-data-is-not-updating-when-alt-tab-to-the-game)

## Tooltips
Most controls have tooltips. Simply hover over them and a tooltip will appear.
![#](images/wtrti_tooltip.png)


## Groups
Groups controls the display of indicators, their position and layout.
Groups controls how the indicators are displayed, their position and layout.

![#](images/wtrti_groups.png)

You can move groups by hotkey.
You can also move a group using keyboard.
Select a group in the main window, **ALT-TAB** to the game and press:
**SHIFT + ALT + ARROWS**

Expand Down Expand Up @@ -60,7 +68,7 @@ Loading profiles by Hotkeys (Profiles slots). Only works while in the battle. Ma
![#](images/wtrti_hotkey_profiles.png)

## Indicators
Double-click on the indicator in the main window to open the indicator settings window.
**Double-click** on the indicator in the main window to open the indicator settings window.

### General
#### Alert
Expand All @@ -69,12 +77,11 @@ Alerts, allows you to specify a range of values within which you will be alerted
![#](images/wtrti_alert_1.png)
![#](images/wtrti_alert_2.png)
![#](images/wtrti_alert_3.png)

For sound alerts, it's recommended that you use a 'relative paths' for audio files by selecting them from the WTRTI root directory, e.g. **Sounds** folder.

!!! tip
For sound alerts, it's recommended that you use a 'relative paths' for audio files by selecting them from the WTRTI root directory, e.g. **Sounds** folder.
This makes the profile more portable, so you can share it with others.
![#](images/wtrti_alert_4.png)

This makes the profile more portable, so you can share it with others.

### Advanced
#### In "State" list
Expand All @@ -94,7 +101,8 @@ The indicator with an in-state key that depends on another in-state indicator (c
4. Press again **X** to stop.

All these hotkeys you can rebind in the **Settings -> Hotkeys tab**.
You can change the logging interval in milliseconds, at **Settings -> General tab -> Benchmark mode -> Logging Interval**.
You can change the logging interval in milliseconds, at
**Settings -> General tab -> Benchmark mode -> Logging Interval**
Generated .CSV files are located in the **Logs** folder.

In the OSD, the benchmark information is positioned in the last group, so if you want to place it in a specific location, create an empty group and move it as you wish.
Expand Down Expand Up @@ -131,8 +139,9 @@ VR support is implemented with **SteamVR**.
2. Start WTRTI and enable **VR mode** (**Settings -> Advanced**).
3. Click the **VR** button in the main window to display the **VR Settings**.

If you have an iGPU, make sure you are using WTRTI on the discrete GPU (High performance):
https://pureinfotech.com/set-gpu-app-windows-10/
!!! warning
If you have an **iGPU**, make sure you are using WTRTI on the discrete GPU (High performance):
<https://pureinfotech.com/set-gpu-app-windows-10/>

### SteamVR Controller Bindings support
Allows you to assign VR controller buttons to specific WTRTI actions.
Expand All @@ -152,8 +161,9 @@ To make settings to be available in SteamVR, you need first go in a "Test Flight


### Oculus users
To make the game run through SteamVR, you have to set the compatibility mode to Windows 7, for aces.exe in win32 and win64 folders.
How-To: In the game root folder, open win32 folder and find aces.exe, open its Properties and set Compatibility mode to Windows 7:
To make the game run through SteamVR, you have to set the compatibility mode to Windows 7, for **aces.exe** in win32 and win64 folders.
How-To:
In the game root folder, open **win32** folder and find **aces.exe**, open its **Properties** and set **Compatibility mode** to Windows 7:
![#](images/aces_properties.png)

Do the same for aces.exe in the win64 folder.
Expand All @@ -162,13 +172,14 @@ It is also recommended to run the game through Steam.

## Advanced
### RTSS OSD Setup
1. Install RTSS.
2. Start WTRTI.
1. [Download](https://www.guru3d.com/files-details/rtss-rivatuner-statistics-server-download.html) and Install RTSS.
2. Start WTRTI.
3. **Settings -> OSD -> OSD Type -> RTSS**
![#](images/wtrti_rtss_mode.png)

> **Note:** Works with text-based indicators **only**.
> Also, RTSS only supports ASCII characters.
!!! warning
RTSS **only** works with text-based indicators.
Also, RTSS only supports **ASCII** characters.

To change the font, see [Changing the fonts](features.md/#rtss_1).

Expand All @@ -182,20 +193,28 @@ This mode contains additional indicators, that **only** works in "Test Flight":
- Thrust to Weight ratio
- Critical G, % (in-battle approximate version)

To make these indicators to work, you need to find the "debug" section in the "config.blk" file in the game root folder, and to add a new line:
To make these indicators to work, follow these steps:

1. Open the game root folder.
2. Open **config.blk** file with text editor.
3. Find `debug` section
4. Emplace this line:
```
enableFMCommands:b=yes
enableFMCommands:b=yes
```
![#](images/wt_config_debug_fm_mode.png)
5. Save the file and Start/Restart the game.
6. Enable "FM mode" in **Settings -> Advanced**.

![#](images/wt_config_debug_fm_mode.png)

### Custom indicators
Open **Add** window (**+** button) -> **New** (or **RMB** on the indicators list).
![!](images/wtrti_custom_indic_1.png)
![!](images/wtrti_custom_indic_2.png)

Use **State** window(press **F2** in the main window) to see which parameters are available.
> **Note:** Empty **State Key** - switches the current indicator into "label" mode, which will only show OSD name and trigger an alerts.
!!! warning
Empty **State Key** - switches the indicator into "label" mode, which will only show OSD name and trigger an alerts.

![!](images/wtrti_state.png)

Expand All @@ -208,24 +227,26 @@ 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.

## OSD on a second screen
Simply switch "Window mode" (Settings->OSD) to "Windowed" and move the "WTRTI OSD" window to a second screen.
![#](images/wtrti_windowed_mode.png)


## Receive data from another PC or Console on the local network
Set another PC's **local** IP address in **Settings** -> **Network** -> **Address**:
> **Note:** leave 8111 port unchanged
!!! info
Leave 8111 port unchanged

![#](images/wtrti_network_ip.png)

## DCS World Setup
1. Copy-Paste the **DCS/Scripts/Export.lua** into **%USERPROFILE%/Saved Games/DCS/Scripts/** folder.
For **DCS Open Beta** use this directory: **%USERPROFILE%/Saved Games/DCS.openbeta/Scripts/**
1. Copy-Paste the **DCS/Scripts/Export.lua** into
**`%USERPROFILE%/Saved Games/DCS/Scripts/`**
For **DCS Open Beta** use this directory:
**`%USERPROFILE%/Saved Games/DCS.openbeta/Scripts/`**
2. Start WTRTI, open **Settings -> Advanced tab -> Enable "TCP Listener"**.
3. Start the game.

Expand All @@ -240,15 +261,20 @@ Click on **Advanced** and enable these options:

![#](images/dcs_mp_server_settings.png)

<!-- TODO: MULTIPLAYER -->

## Changing the fonts
### WTRTI
![#](images/wtrti_font_1.png)
![#](images/wtrti_font_2.png)

!!! tip
You can use a custom font file.
Simply place a TTF file into **Fonts** folder and select it in Settings.

### RTSS
![#](images/rtss_font_1.png)
![#](images/rtss_font_2.png)

!!! tip
In order to use custom font files, you will need to install them on your system.

21 changes: 12 additions & 9 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ A highly customizable HUD overlay and logging tool for War Thunder.


[Download](https://github.com/MeSoftHorny/WTRTI/releases/latest/){ .md-button .md-button--primary }
[WIP Versions](https://patreon.com/wtrti){ .md-button .md-button--primary }

## Features
- More than 30 types of indicators (Climb, AoA, Turning time, Turning radius, Fuel consumption, WEP remain, Booster remain, etc.).
> **Note:** Ammo related information is not available (or very limited) on the web-map, so it cannot be added to the app.
!!! info
Ammo related 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. Borderless window with transparency, that requires "Fullscreen Window" mode to be enabled. See [OSD Setup](features.md#wtrti-built-in).
- RTSS - using "RivaTuner Statistics Server" OSD functionality. Works with any window mode.
- VR support (SteamVR only).
- Custom indicators, allows you to make a new indicators with a specific reading properties from localhost:8111.
- Lua scripts, for custom processing of indicator values.
- **WTRTI** - Built-in OSD. Borderless window with transparency, that requires "Fullscreen Window" mode to be enabled. See [OSD Setup](features.md#wtrti-built-in).
- **RTSS** - using "RivaTuner Statistics Server" OSD functionality. Works with any window mode.
- VR support (**SteamVR only**).
- **Custom indicators**, allows you to make a new indicators with a specific reading properties from localhost:8111.
- **Lua** scripts, for custom processing of indicator values.
- Custom "Alert" conditions for indicators, with Sound playback.
- Per-vehicle profile, with automatic loading at the beginning of a battle.
- Hotkey actions (e.g. Profile loading).
Expand All @@ -29,10 +31,11 @@ WTRTI does not make any changes to the game process or its data, it 'only' proce

## Installation
1. Download [**the latest version**](https://github.com/MeSoftHorny/WTRTI/releases/latest).
2. Extract it to a seperate folder with write permissions.
> **Note:** Make sure it is not in the game root directory, otherwise the game launcher will delete WTRTI.exe file in there.
2. Extract it to a seperate folder with **write permissions**.
>**Note**: Make sure it is not in the game root directory, otherwise the game launcher will delete WTRTI.exe file in there.
3. Run WTRTI.exe.
4. [Setup the game for OSD](features.md#wtrti-built-in)
4. Add some indicators (**+** button) to the list.
5. [Setup the game for OSD](features.md#wtrti-built-in)

### Upgrade from previous versions
Simply extract the downloaded zip file into the folder where the old version is located.
Expand Down
11 changes: 7 additions & 4 deletions docs/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ Try to turn off the "Hardware Accelerated GPU Scheduling":
## 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).
**Warning:** At some point, the overlay may continue to be displayed when you are in the menu, in which case try disabling this option.
**Note:** Some indicators may not work due to the limited amount of data available from the localhost:8111, e.g. Critical AoA, Critical Air Speed.
!!! 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
At some point, the overlay may continue to be displayed when you are in the menu, in which case try disabling this option.

## OSD is not show up" or "Data is not updated in the main window
If you have antivirus, try adding an exclusion for WTRTI.
Expand All @@ -26,5 +28,6 @@ Can be a few things:
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 "fuel" in "State"" window (press F2 in the main window), while you in Test Flight.
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.

3 changes: 3 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ site_name: WTRTI

markdown_extensions:
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences

nav:
- Getting Started: index.md
Expand Down

0 comments on commit 7e1c5d5

Please sign in to comment.