Skip to content

Commit 3f389e3

Browse files
committedMay 29, 2023
Update README.md
1 parent 66d8e88 commit 3f389e3

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed
 

‎README.md

+47-3
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,58 @@ Inspired by [b1naryth1ef/sneaker](https://github.com/b1naryth1ef/sneaker).
77
The name `peace-eye` is derived from [Korean version of Boeing 737 AEW&C "Peace Eye"](https://en.wikipedia.org/wiki/Boeing_737_AEW%26C).
88
Powered by [tauri](https://tauri.app/).
99

10-
## Prerequisites
10+
## Usage
11+
12+
> Server should support Tacview realtime telemetry!
13+
14+
Download the latest release in [Release page](https://github.com/pbzweihander/peace-eye/releases/latest) and install it.
15+
16+
![guide screenshot 1](./guide-screenshot1.png)
17+
18+
Enter the server's domain or IP in `Host` input.
19+
For example, `dcs.hoggitworld.com` for hoggit GAW.
20+
21+
Enter the Tacview realtime telemetry server's port number in `Port` input.
22+
If you are not sure, just don't touch it.
23+
24+
You can enter anything you like in `Username` input.
25+
It is not relevant.
26+
27+
If your server has password for Tacview realtime telemetry server (not DCS server!), enter it in `Password` input.
28+
For example, hoggit GAW has same DCS server password for Tacview realtime telemetry server. (Which I'm not gonna write it here.)
29+
30+
And press `CONNECT` button.
31+
32+
![screenshot](./screenshot.png)
33+
34+
After waiting some seconds, you can see above screen.
35+
If you are not, check `Host`, `Port`, and `Password` was correct.
36+
37+
This is your main screen.
38+
Various options can be set or unset in settings menu, located on top right cogwheel button.
39+
40+
### Features
41+
42+
- Drag with left click to pan the view.
43+
- Drag with right click to measure bearing and range.
44+
- On the right bottom screen, you can see the bullseye of the cursor location.
45+
- In settings menu, you can choose to see coordinates of the cursor location.
46+
- In bottom right of each object, you can see altitude (in thousands of feets), estimated ground speed (in knots), estimated altitude rate (in thousands of feets per minutes).
47+
- Click the object to see various information of the object.
48+
- In object information, you can press `CENTER` button to center the view to the object.
49+
- You can set warning radius, and thread radius, which represented in yellow and red circle.
50+
- You can set the object to `Watch` state. Watched objects can be quick-accessed in the top right `WATCHES` button on screen.
51+
- Search the object with name via `SEARCH` button on the top right button on screen.
52+
53+
## Development
54+
55+
### Prerequisites
1156

12-
- Server should support Tacview realtime telemetry
1357
- [Tauri Prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites)
1458
- [Rust](https://www.rust-lang.org/)
1559
- [Node](https://nodejs.org/en/)
1660

17-
## Usage
61+
### Running in development mode
1862

1963
```
2064
yarn tauri dev

‎guide-screenshot1.png

11.7 KB
Loading

0 commit comments

Comments
 (0)