From db031bb5e386358bac4dcb8136fd1e2708be77f4 Mon Sep 17 00:00:00 2001 From: "Philipp Wagner (DN9APW)" Date: Thu, 26 Mar 2026 01:49:28 +0100 Subject: [PATCH] Docs EN changed to include new Changes --- github_docs/en-AirScout-Integration.md | 5 ++ github_docs/en-Changelog.md | 2 + github_docs/en-Configuration.md | 55 ++++++++++-------- github_docs/en-Home.md | 4 +- github_docs/en-Installation.md | 77 ++++++++++++++++++-------- github_docs/en-Log-Sync.md | 29 +++++++++- 6 files changed, 122 insertions(+), 50 deletions(-) diff --git a/github_docs/en-AirScout-Integration.md b/github_docs/en-AirScout-Integration.md index 37b0352..49be664 100644 --- a/github_docs/en-AirScout-Integration.md +++ b/github_docs/en-AirScout-Integration.md @@ -32,6 +32,8 @@ An account is required for this service. Please consider donating to Thomas – 1. Start AirScout. 2. Enter your OV3T feed account details (username, password, URL) in the AirScout settings. +![AirscoutStep1](as_plane_feed_1.png) +![AirscoutStep2](as_plane_feed_2.png) 3. Test the connection. ### Step 2: Enable UDP Communication for KST4Contest @@ -46,6 +48,9 @@ In AirScout, enable the UDP interface: In KST4Contest Preferences → **AirScout Settings**: - Enable AirScout communication - Leave IP and port at their default values (unless changed) +![AirscoutStep3](as_plane_feed_3.png) + + --- diff --git a/github_docs/en-Changelog.md b/github_docs/en-Changelog.md index 3c21925..27b8dda 100644 --- a/github_docs/en-Changelog.md +++ b/github_docs/en-Changelog.md @@ -6,6 +6,8 @@ Version history of KST4Contest / PraktiKST. --- +For the latest changelog, please refer to GitHub. The previous changelog is below. + ## v1.263 (2025-06-08) **AirScout Communication and Login Name** diff --git a/github_docs/en-Configuration.md b/github_docs/en-Configuration.md index b4a9a35..462752c 100644 --- a/github_docs/en-Configuration.md +++ b/github_docs/en-Configuration.md @@ -4,29 +4,36 @@ After the first start, the **settings window** opens – this is the central starting point for all configuration. It is recommended to keep the settings window open during operation (e.g. to quickly toggle the beacon on and off). -> **Important**: Always click **"Save Settings"** after any change! Settings are stored in `~/.praktikst/preferences.xml`. From v1.21 onwards, window sizes and divider positions are also saved when you click Save. +> **Important**: Always click **"Save Settings"** after any change! Settings are stored in `~/.praktikst/preferences.xml` on Linux and in `%USERPROFILE%\.praktikst\preferences.xml` (or `C:\Users\\.praktikst\preferences.xml`) on Windows. From v1.21 onwards, window sizes and divider positions are also saved when you click Save. --- ## Station Settings +![Station Settings](client_settings_window_station.png) +### Login and Chat Categories + +Enter your ON4KST chat credentials here (callsign and password). +Also, select the **primary chat category** (e.g., IARU Region 1 VHF/Microwave). + +With the option for a **second chat** (Multi-Channel Login), you can log in to another category simultaneously (e.g., UHF/SHF). Both chats will then be monitored in parallel. You can optionally specify a different login name for the second chat (useful for Opposite Station Multi-Callsign Logging). ### Callsign and Locator -Enter your callsign and Maidenhead locator (6 characters, e.g. `JN49IJ`). These values are used for distance and direction calculations. +Enter your own callsign and Maidenhead locator (6 characters, e.g., `JN49IJ`). These values are needed for distance and direction calculations. ### Active Bands -Use the **"my station uses band"** checkboxes to select which bands you are active on. Only selected bands will show buttons and table rows in the user interface. A restart is required after changing these settings. +Use the **"my station uses band"** checkboxes to select the active bands. Buttons and table rows will only appear in the user interface for selected bands. The software must be restarted after making changes. ### Antenna Beamwidth -Enter a realistic value for your antenna's beamwidth (in degrees). This value is used for the [Sked Direction Highlighting](Features#sked-direction-highlighting). A test value of 50° has proven useful; DM5M uses Quads with 69°. +Enter a realistic value for your antenna's beamwidth (in degrees). This value is used for the [Sked Direction Highlighting](Features#sked-direction-highlighting). A test value of 50° has proven effective; DM5M uses quads with 69°. -> **Do not** enter fantasy values – the direction calculations will become meaningless. +> **Do not** enter fantasy values – the direction calculations will become useless. ### Default Maximum QRB -Maximum distance (in km) for which direction warnings should be triggered. A realistic value for DM5M is 900 km. Stations beyond this distance are ignored for highlighting purposes. +Maximum distance (in km) for which direction warnings should be triggered. A realistic value for DM5M is 900 km. Stations farther away are ignored for highlighting purposes. --- @@ -36,17 +43,21 @@ Two methods are available for automatically marking worked stations. Details: [L ### Universal File Based Callsign Interpreter (Simplelogfile) -Interprets any log file using regex to find callsign patterns. No band information available. Suitable as a fallback or for unsupported logging programs. +Interprets any log file using regex for callsign patterns. No band information is available. Suitable as a fallback or for log programs that are not directly supported. ### Network Listener for Logger's QSO UDP Broadcast -**Recommended method.** KST4Contest listens for UDP packets sent by the logging software when saving a QSO. Stations are marked including band information. UDP port: default **12060**. +**Recommended method.** KST4Contest listens for UDP packets sent by the logging software to the broadcast address when a QSO is saved. Stations are marked with band information. UDP port: default **12060**. (Used by UCXLog, N1MM+, QARTest, DXLog.net, etc.). + +### Win-Test Network Listener (Additional UDP Listener) + +A dedicated network listener for Win-Test. KST4Contest receives and processes Win-Test-specific UDP packets (including sked handovers) on the configured port. --- ## TRX Sync Settings -Receives the current transceiver frequency from the logging software via UDP. Makes the `MYQRG` variable available automatically. Useful for: +Receives the current transceiver frequency from the logging software via UDP. This enables the automatic population of the `MYQRG` variable. Useful for: - Quickly inserting your own QRG into chat messages. - Automatic CQ beacon with current frequency. @@ -67,13 +78,13 @@ Three notification types are available: 1. **Simple sounds**: TADA sound for incoming messages, tick for sked direction detection, etc. 2. **CW announcement**: The callsign of a station sending a private message is output as a CW signal. -3. **Phonetic announcement**: The callsign is spoken phonetically. +3. **Phonetic announcement**: The callsign is pronounced phonetically. --- ## Shortcut Settings -Configure quick-access buttons that appear directly in the main window. Clicking a button inserts the configured text into the send field. All [variables](Macros-and-Variables#variables) can be used. +Configuration of quick-access buttons that appear directly in the main window. Clicking a button inserts the configured text into the send field. All [variables](Macros-and-Variables#variables) can be used. --- @@ -93,9 +104,9 @@ If a callsign is selected in the user list, the snippet is addressed as a direct ## Beacon Settings -Configure an automatic interval message in the public chat channel. Recommended: use the `MYQRG` variable in the text so the current frequency is always up to date. Interval and text are freely configurable. +Configuration of an automatic interval beacon in the public chat channel. Recommended: use the `MYQRG` variable in the text so the current frequency is always up to date. Interval and text are freely configurable. -> **Tip**: Enable the beacon while calling CQ and quickly disable it in the settings window when not calling. +> **Tip**: Enable the beacon when calling CQ and quickly disable it in the settings window when not calling. --- @@ -104,32 +115,32 @@ Configure an automatic interval message in the public chat channel. Recommended: New settings section with the following options: - **Auto-reply to all incoming messages**: Configurable automatic reply to private messages. -- **Auto-reply with CQ QRG**: When someone asks for your frequency, KST4Contest automatically replies with the `MYQRG` variable content. -- **Default filter for the userinfo window**: Pre-configured message filter for the station info panel *(for Gianluca :-) )*. +- **Auto-reply with own CQ QRG**: When someone asks for your QRG, KST4Contest automatically replies with the content of the `MYQRG` variable. +- **Default filter for the userinfo window**: Pre-configured message filter for the station info window *(for Gianluca :-) )*. --- ## Worked Station Database Settings -Reset the internal worked database before each contest! Contains: +Reset the internal worked database before each contest! It contains: -- Worked status for all stations (per band) +- Worked status of all stations (per band) - NOT-QRV tags (since v1.2) -Use the **"Reinitialize"** button below the table. A planned feature is an automatic expiry time for the worked status. +Use the **"Reinitialize"** button below the table. A planned feature is an automatic expiration time for the worked status. --- ## Dark Mode (from v1.26) -Toggle via the menu: **Window → Use Dark Mode**. Colours can be individually customised via CSS. +Toggle via the menu: **Window → Use Dark Mode**. The colors can be individually customized via CSS. --- ## Saving Settings -Click **"Save Settings"** after **every** change! Without saving, all changes are lost on next start. +Click **"Save Settings"** after **every** change! Without saving, all changes will be lost on the next start. -- Storage location: `~/.praktikst/preferences.xml` +- Storage location: `~/.praktikst/preferences.xml` on Linux and `%USERPROFILE%\.praktikst\preferences.xml` (or `C:\Users\\.praktikst\preferences.xml`) on Windows - From v1.21: Window sizes and divider positions are also saved. -- If you encounter problems: delete the configuration file → KST4Contest creates a new one with default values. +- If you encounter problems: delete the configuration file → KST4Contest will create a new one with default values. diff --git a/github_docs/en-Home.md b/github_docs/en-Home.md index 695b93f..e1c908c 100644 --- a/github_docs/en-Home.md +++ b/github_docs/en-Home.md @@ -12,14 +12,14 @@ Developed by **DO5AMF (Marc Fröhlich)**, operator at DM5M. | Page | Contents | |---|---| -| [Installation](en-Installation) | Download, Java requirements, updates | +| [Installation](en-Installation) | Download, Java requirements, update | | [Configuration](en-Configuration) | All settings in detail | | [Log Synchronisation](en-Log-Sync) | UCXLog, N1MM+, QARTest, DXLog.net, WinTest | | [AirScout Integration](en-AirScout-Integration) | Aircraft scatter detection | | [DX Cluster Server](en-DX-Cluster-Server) | Built-in DX cluster for your logging software | | [Features](en-Features) | All features at a glance | | [Macros and Variables](en-Macros-and-Variables) | Text snippets, shortcuts, variables | -| [User Interface](en-User-Interface) | UI explained and how to operate it | +| [User Interface](en-User-Interface) | UI explanation and operation | | [Changelog](en-Changelog) | Version history | --- diff --git a/github_docs/en-Installation.md b/github_docs/en-Installation.md index 10361f4..b283771 100644 --- a/github_docs/en-Installation.md +++ b/github_docs/en-Installation.md @@ -4,23 +4,19 @@ ## Prerequisites -### Java - -KST4Contest is a Java application. A current **Java Runtime Environment (JRE)** is required. The recommended version is Java 17 or higher. - ### ON4KST Account -To use the chat client, you need a registered account with the ON4KST chat service: +To use the chat, a registered account with the ON4KST chat service is required: - Register at: http://www.on4kst.info/chat/register.php -### Behavioural Etiquette +### Chat Etiquette The official language in the ON4KST Chat is **English**. Please use English even when communicating with stations from your own country. Common HAM abbreviations (agn, dir, pse, rrr, tnx, 73 …) are widely used and understood. -### Sending Personal Messages +### Personal Messages -To send a private message to another station, always use this format: +To send a private message to another station, always use the following format: ``` /CQ CALLSIGN message text @@ -28,45 +24,78 @@ To send a private message to another station, always use this format: Example: `/CQ DL5ASG pse sked 144.205?` -During contest operation (5–6 messages per second in the public channel), public messages directed at a specific callsign are easily missed. KST4Contest also catches such messages if they are accidentally posted publicly (see [Features – PM Catching](Features#pm-catching)). +During heavy chat traffic (5–6 messages per second in a contest), public messages directed at a specific callsign are easily missed. However, KST4Contest also catches such messages if they are accidentally posted publicly (see [Features – PM Catching](Features#catching-personal-messages)). --- ## Download +### Windows + The latest version can be downloaded as a ZIP file: -**https://do5amf.funkerportal.de/** +**https://github.com/praktimarc/kst4contest/releases/latest** + +The filename has the format `praktiKST-v-windows-x64.zip`. + +### Linux + +The latest version can be downloaded as an AppImage: + +**https://github.com/praktimarc/kst4contest/releases/latest** + +The filename has the format `praktiKST-v-linux-x86_64.AppImage`. -The filename follows the pattern `kst4Contest_v.zip`. --- ## Installation -1. Download the ZIP file. -2. Unzip into a folder of your choice. -3. Run `praktiKST.exe` (Windows) or the corresponding start script. +### Windows -Settings are stored at `%USERPROFILE%\.praktikst\preferences.xml` (Windows). +1. Download the ZIP file. +2. Unzip the ZIP file into a folder of your choice. +3. Run `praktiKST.exe`. + +Settings are stored at `%USERPROFILE%\.praktikst\preferences.xml`. + +### Linux +1. Download the AppImage. +2. Unzip the AppImage into a folder of your choice. +3. Make the AppImage executable (in the terminal with `chmod +x praktiKST-v-linux-x86_64.AppImage`) +4. Run the AppImage. + +Settings are stored at `~/.praktikst/preferences.xml`. --- ## Updating -KST4Contest includes an **automatic update notification service**: when a new version is available, a window will appear at startup showing: -- A notification that a new version is available -- A changelog -- The download link for the latest package +KST4Contest includes an **automatic update notification service**: as soon as a new version is available, a window will appear at startup with: +- information that a new version is available, +- a changelog, +- the download link for the new version. + +![Example Update Window](update_window.png) ### Update Process -Currently the only way to update is: +#### Windows + +Currently, there is only one way to update: 1. Delete the old folder. -2. Unzip the new package. +2. Unzip the new ZIP file. + +The settings file (`preferences.xml`) is preserved because it is stored in the user folder, not the program folder. + +#### Linux + +Currently as follows: +1. Download the new AppImage +2. Mark the new AppImage as executable +3. (optional) Delete the old AppImage. -Your settings file (`preferences.xml`) is preserved since it is stored in your user folder, not the program folder. --- @@ -74,10 +103,10 @@ Your settings file (`preferences.xml`) is preserved since it is stored in your u ### Norton 360 -Norton 360 flags `praktiKST.exe` as dangerous (false positive). You need to add an exception: +Norton 360 classifies `praktiKST.exe` as dangerous (false positive). An exception must be created for the file: 1. Open Norton 360. -2. Security → History → Find the relevant event. +2. Security → History → Find the corresponding event. 3. Select "Restore & Add Exception". *(Reported by PE0WGA, Franz van Velzen – thank you!)* diff --git a/github_docs/en-Log-Sync.md b/github_docs/en-Log-Sync.md index d47cdcc..0a4f3e0 100644 --- a/github_docs/en-Log-Sync.md +++ b/github_docs/en-Log-Sync.md @@ -5,6 +5,7 @@ KST4Contest automatically marks worked stations in the chat user list. Two basic methods are available: --- +![Log Sync Settings Window](client_settings_window_logsync.png) ## Method 1: Universal File Based Callsign Interpreter (Simplelogfile) @@ -32,6 +33,7 @@ When saving a QSO, the logging software sends a UDP packet to the broadcast addr ## Supported Logging Software ### UCXLog (DL7UCX) +![UCXLog Configuration](ucxlog_logsync.png) UCXLog sends QSO UDP packets and transceiver frequency packets. @@ -46,6 +48,8 @@ Note for multi-setup (2 computers, 2 radios, one KST4Contest instance): Both log ### QARTest (IK3QAR) +![QARTest Configuration](qartest_logsync.png) + **Special feature**: QARTest can send the **complete log** to KST4Contest (button "Invia log completo" in the QARTest settings). This means QSOs logged before KST4Contest was started are also captured. **Settings in QARTest:** @@ -68,14 +72,33 @@ For the built-in DX cluster server: configure N1MM+ as a DX cluster client (serv ### DXLog.net +![DXLog.net Configuration](dxlog_net_logsync.png) + **Settings in DXLog.net:** - Enable UDP broadcast - Enter the IP of the KST4Contest computer (green-highlighted fields) - Port: 12060 -### WinTest +### Win-Test -WinTest is also supported. KST4Contest receives WinTest UDP packets via a dedicated listener. Configuration is analogous to the other programs. +Win-Test is supported with a dedicated UDP network listener that understands the native Win-Test network protocol. + +**Advantages of Win-Test Integration:** +- Automatic QSO synchronization to mark worked stations. +- **Sked Handover (ADDSKED):** Using the "Create sked" button in the station info panel not only creates a sked in KST4Contest but also *sends it directly via UDP to the Win-Test network as an ADDSKED packet*. +- You can choose between "AUTO", "SSB", or "CW" sked modes. + +**Required Settings in KST4Contest:** +- `UDP-Port for Win-Test listener` (Default: 9871). +- Enable `Receive Win-Test network based UDP log messages`. +- Enable `Win-Test sked transmission (push via ADDSKED to Win-Test network)`. +- `KST station name in Win-Test network (src of SKED packets)`: Defines the station name KST4Contest uses in the WT network (e.g., "KST"). +- `Win-Test station name filter`: If a name is entered here (e.g., "STN1"), only QSOs from that specific Win-Test instance will be processed. Leave empty to accept all. +- `Win-Test network broadcast address`: Is usually detected automatically and is required to send sked packets to the network. + +**Settings in Win-Test:** +- The network in Win-Test must be active. +- Win-Test must be configured to send/receive its broadcasts on the corresponding port (default 9871). --- @@ -83,6 +106,8 @@ WinTest is also supported. KST4Contest receives WinTest UDP packets via a dedica In addition to QSO synchronisation, UCXLog and other programs also transmit the **current transceiver frequency** via UDP. KST4Contest processes this information and makes it available as the `MYQRG` variable. +![Frequency Buttons](qrg_buttons.png) + **Result**: Your own QRG never needs to be typed manually in the chat – clicking the MYQRG button or using the variable in the beacon is sufficient. > **Note for multi-setup**: With two logging programs on two computers, only **one** should send frequency packets. KST4Contest cannot distinguish between sources and processes all incoming packets.