Skip to content

Commit

Permalink
docs: - Add Gamescope info
Browse files Browse the repository at this point in the history
      - Small clean-up
  • Loading branch information
MeSoftHorny committed Dec 22, 2023
1 parent 7e1c5d5 commit c31ef23
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 6 deletions.
38 changes: 33 additions & 5 deletions docs/docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,35 @@ It is also recommended to run the game through Steam.
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).
To change the font, see [Changing the fonts](features.md/#rtss).

### Gamescope Setup (Linux)
There are two ways to use gamescope:

##### Create a script:
```
#!/bin/bash
export PATH=$PATH:/path/to/WTRTI
./launcher &
WTRTI
```
Place it in the game root directory, where the launcher is, and run it with Gamescope:
`gamescope ./run.sh`

##### From command line:
1. Start the game with Gamescope:
`gamescope ./launcher`
2. Launch WTRTI from another command line:
`GAMESCOPE_DISPLAY=:2 ./WTRTI`

!!! note
**GAMESCOPE_DISPLAY** should be the name of the gamescope Xwayland server.
When you start the game with gamescope, you can see what name gamescope uses.
`wlserver: [xwayland/server.c:108] Starting Xwayland on :2`

!!! warning
After playing, **first close WTRTI** and then the game!
Otherwise it will crash and you may lose your configuration.

### FM Mode
This mode contains additional indicators, that **only** works in "Test Flight":
Expand Down Expand Up @@ -237,8 +265,8 @@ Simply switch "Window mode" (Settings->OSD) to "Windowed" and move the "WTRTI OS

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

![#](images/wtrti_network_ip.png)

Expand All @@ -251,12 +279,12 @@ Set another PC's **local** IP address in **Settings** -> **Network** -> **Addres
3. Start the game.

### Multiplayer
#### Hosted server
##### Hosted server
Check if the server has these options in the DCS World multiplayer lobby window:

![#](images/dcs_mp_server_permissions.png)

#### Creating a Server
##### Creating a Server
Click on **Advanced** and enable these options:

![#](images/dcs_mp_server_settings.png)
Expand Down
4 changes: 3 additions & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ A highly customizable HUD overlay and logging tool for War Thunder.
- Experimental **DCS World** support, see [DCS World Setup](features.md#dcs-world-setup).

## How it works
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.
This is **not** a mod.
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 (Overlay).

## Installation
1. Download [**the latest version**](https://github.com/MeSoftHorny/WTRTI/releases/latest).
Expand All @@ -46,6 +47,7 @@ Simply extract the downloaded zip file into the folder where the old version is
- **OS**: **Windows** 7 or higher.
**Linux**: Ubuntu 20.04 and later. X11.
*Borderless window mode requires Compositor (eg. kwin, compiz).*
*Since v2.2.5, you can use __Gamescope__, See [How-To](features.md/#gamescope-setup-linux).*
- **Graphics**: Buit-in OSD: Any OpenGL 3.3 compatible GPU or greater.
*RTSS OSD: Rivatuner Statistics Server v7.3+. [Download](https://www.guru3d.com/files-details/rtss-rivatuner-statistics-server-download.html)*
- **VR**: SteamVR. See [VR](features.md/#vr) for more info.

0 comments on commit c31ef23

Please sign in to comment.