Skip to content

Commit 942fc68

Browse files
committed
Update README
Improve README Improved readme Fix centering Remove bg from preview image Change date to prevent cache Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Fix URL Update settings to omit some headers in README.md Remove packaging
1 parent ed59167 commit 942fc68

File tree

4 files changed

+69
-11
lines changed

4 files changed

+69
-11
lines changed

.vscode/settings.json

+12
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@
1616
"typescript.tsserver.watchOptions": {
1717
"excludeDirectories": ["**/node_modules", "dist", "release"]
1818
},
19+
"markdown.extension.toc.omittedFromToc": {
20+
"README.md": [
21+
"## Table of Contents",
22+
"## Key Features",
23+
"## Build process",
24+
"### Dependencies",
25+
"### Linux",
26+
"### Windows",
27+
"### macOS",
28+
"## Packaging"
29+
]
30+
},
1931
"files.associations": {
2032
"xstring": "cpp",
2133
"valarray": "cpp",

README.md

+57-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,67 @@
1-
# TrackAudio
2-
3-
A next generation Audio-For-VATSIM ATC Client for macOS, Linux and Windows.
4-
5-
![screengrab of application](https://raw.githubusercontent.com/pierr3/TrackAudio/main/docs/app_screenshot_jan2025.png)
6-
7-
## Releases
8-
9-
See [releases](https://github.com/pierr3/TrackAudio/releases) for latest builds, remember that beta builds may be unstable. Please report any issues on GitHub.
1+
<!-- markdownlint-disable MD033 MD045 MD007 -->
2+
<!-- no toc -->
3+
<h1>
4+
<img src="https://raw.githubusercontent.com/pierr3/TrackAudio/main/build/icon.png" width="50" valign="middle">
5+
<span style="font-size: 2em; font-weight: bold">TrackAudio</span>
6+
</h1>
7+
8+
[![Release](https://img.shields.io/github/v/release/pierr3/TrackAudio)](https://github.com/pierr3/TrackAudio/releases)
9+
10+
> **New to TrackAudio?** 📖 Check out the [Key Features](#key-features) and [FAQ](#faq) before getting started!
11+
12+
🔊 A next generation Audio-For-VATSIM ATC Client for macOS, Linux and Windows.
13+
14+
💡 Get the latest version from our [releases page](https://github.com/pierr3/TrackAudio/releases). Beta builds are available but may be unstable. Found an issue? [Report it](https://github.com/pierr3/TrackAudio/issues/new)!
15+
16+
![screengrab of application](https://raw.githubusercontent.com/pierr3/TrackAudio/main/docs/app_screenshot_feb2025.png)
17+
18+
## Key Features
19+
20+
- 🖥️ Cross-platform support for macOS, Linux, and Windows
21+
- 🎚️ Independent volume and mute controls for each radio
22+
- 🕹️ Dual push-to-talk capability
23+
- 📡 Built-in Unicom & Guard support
24+
- 🎮 Comprehensive Stream Deck integration
25+
- 🪟 Compact mini-mode with transparency options
26+
- 🔌 Developer-friendly SDK with WebSocket and HTTP support
27+
28+
## Table of Contents
29+
30+
- [FAQ](#faq)
31+
- [What's the difference between VectorAudio and TrackAudio?](#whats-the-difference-between-vectoraudio-and-trackaudio)
32+
- [Why does the audio sound different compared to the older AFV for Windows client?](#why-does-the-audio-sound-different-compared-to-the-older-afv-for-windows-client)
33+
- [My PTT does not work on macOS](#my-ptt-does-not-work-on-macos)
34+
- [I attempted to set a PTT, but it displays the name 'Unknown (XXX)'](#i-attempted-to-set-a-ptt-but-it-displays-the-name-unknown-xxx)
35+
- [I'm unable to set a PTT because it automatically assigns to my Joystick](#im-unable-to-set-a-ptt-because-it-automatically-assigns-to-my-joystick)
36+
- [Where are the log and config files stored?](#where-are-the-log-and-config-files-stored)
37+
- [The station I am trying to add is not found](#the-station-i-am-trying-to-add-is-not-found)
38+
- [Is there RDF support in EuroScope?](#is-there-rdf-support-in-euroscope)
39+
- [Is there Stream Deck support?](#is-there-stream-deck-support)
40+
- [Does TrackAudio support HF Simulation?](#does-trackaudio-support-hf-simulation)
41+
- [Can I add a frequency manually if it does not exist in the database?](#can-i-add-a-frequency-manually-if-it-does-not-exist-in-the-database)
42+
- [What is XC and XCA?](#what-is-xc-and-xca)
43+
- [Can I extend TrackAudio using a plugin/is there an SDK?](#can-i-extend-trackaudio-using-a-pluginis-there-an-sdk)
44+
- [Ports and endpoints access required for TrackAudio](#ports-and-endpoints-access-required-for-trackaudio)
45+
- [How to enable verbose logging (advanced)](#how-to-enable-verbose-logging-advanced)
46+
- [I have an issue with TrackAudio](#i-have-an-issue-with-trackaudio)
47+
- [Installation](#installation)
48+
- [Build](#build)
49+
- [Contributing](#contributing)
1050

1151
## FAQ
1252

1353
### What's the difference between VectorAudio and TrackAudio?
1454

1555
TrackAudio is simply the next iteration of VectorAudio, using a different set of technology. VectorAudio is no longer maintained and supported, so you should switch to TrackAudio as soon as possible.
1656

57+
### Why does the audio sound different compared to the older AFV for Windows client?
58+
59+
TrackAudio offers multiple types of radio hardware, Schmid ED-137B is set by default and can changed in settings, these dictate how the received audio from the network is processed.
60+
61+
- Schmid ED-137B – Perceived as clearer audio with slight distortion, emphasising lower frequencies
62+
- Rockwell Collins 2100 – Typical radio-like distortion, commonly used in Boeing and Airbus aircraft (resembles the "Realistic ATC Audio Effect" in the older AFV for Windows client)
63+
- Garrex 220 – Similar to the Schmid ED-137B, but with slightly less distortion and a greater emphasis on higher frequencies.
64+
1765
### My PTT does not work on macOS
1866

1967
macOS has strict permissioning around background keyboard inputs. TrackAudio should prompt you on first launch to request input monitoring permissions. Sometimes, upon updating the app, this setting will undo itself. In that case, please go to your Settings -> Privacy & Security -> Input Monitoring and add TrackAudio in the list (remove it if it was already there). This is required purely because otherwise, your Push to Talk would not work when the window is not in focus (if you use a keyboard push to talk, a Joystick push to talk does not require this permission)
@@ -135,8 +183,6 @@ Download the latest release on the [release page](https://github.com/pierr3/Trac
135183

136184
## Build
137185

138-
### Dependencies
139-
140186
TrackAudio depends on afv-native and SFML (for input handling).
141187

142188
`cmake` is required to build the project. Dependencies will be downloaded through vcpkg at build time. See vcpkg.json for further details.

docs/app_screenshot_feb2025.png

80.1 KB
Loading

docs/app_screenshot_jan2025.png

-53.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)