readme 2.4.0

Author: thatzok

.github/workflows/release.yml

@@ -25,13 +25,13 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
 
-      # 1. DLLs für 32-Bit (x86) bauen
+      # DLLs für 32-Bit (x86) bauen
       - name: Build DLLs
         run: |
           cargo build --release --target i686-pc-windows-msvc
           cargo build --release --target i686-pc-windows-msvc --example omsilogger
 
-      # 2. Paketstruktur vorbereiten (Inklusive .opl Dateien)
+      # Paketstruktur vorbereiten (Inklusive .opl Dateien)
       - name: Prepare Package Folder
         run: |
           mkdir release_pkg
@@ -42,12 +42,12 @@ jobs:
           cp omsi2komsi.opl release_pkg/
           cp omsilogger.opl release_pkg/
 
-      # 3. ZIP erstellen
+      # ZIP erstellen
       - name: Create ZIP Archive
         run: |
           Compress-Archive -Path release_pkg/* -DestinationPath "omsi_2_komsi_${{ github.ref_name }}_x86.zip"
 
-      # 4. Release erstellen
+      # Release erstellen
       - name: Create Release
         uses: softprops/action-gh-release@v2
         with:

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "omsi_2_komsi"
-version = "2.3.3"
+version = "2.4.0"
 edition = "2024"
 rust-version = "1.92"
 authors = ["ThatZok <af@komplix.de>"]

Cargo.toml

@@ -0,0 +1,51 @@
+# Omsi2Komsi
+
+[Deutsche Vrsion](README.md)
+
+Omsi2Komsi is a collection of tools for the "OMSI 2" bus simulator, written in Rust.
+
+## Projects
+
+### Omsi2Komsi (Main Plugin)
+
+Omsi2Komsi is a plugin DLL that reads information (speed, lamps, etc.) from OMSI 2 and sends it to a serial port (USB) using the [KOMSI protocol](https://github.com/thatzok/Komsi-Protocol).
+
+An Arduino/ESP32 or similar device connected to the USB port can then read these messages and display the data on a physical bus dashboard (e.g., speed on a speedometer, lamp lighting, etc.).
+
+#### Usage
+
+1. Copy both `omsi2komsi.dll` and `omsi2komsi.opl` into the `plugins` directory of OMSI 2.
+2. Edit the `omsi2komsi.opl` file and change the `portname` to the one where your Arduino/ESP32 is connected.
+3. Start OMSI 2.
+4. By default, press **F10** to toggle the logger window visibility.
+
+The configuration is done via the `omsi2komsi.opl` file, which must be located in the same directory as the DLL.
+
+
+### OmsiLogger
+
+OmsiLogger is a diagnostic tool that displays real-time values of OMSI 2 variables in an overlay window and logs them to a file.
+
+#### Usage
+
+1. Copy `omsilogger.dll` (compiled from the example) and `omsilogger.opl` into the `plugins` directory.
+2. Start OMSI 2.
+3. By default, press **F10** to toggle the logger window visibility.
+4. It will log the changed values defined in `omsilogger.opl` to a file named `omsilogger_YYYY-MM-DD.txt` in the OMSI 2 directory.
+
+The configuration file `omsilogger.opl` allows you to define the variables to monitor and the hotkey:
+
+
+
+**Have fun!**
+
+
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](LICENSE) for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
+

README.en.md

@@ -1,49 +1,51 @@
 # Omsi2Komsi
 
-Omsi2Komsi is a collection of tools for the "OMSI 2" bus simulator, written in Rust.
+[English version](README.en.md)
 
-## Projects
+Omsi2Komsi ist eine Sammlung von Werkzeugen für den Bussimulator "OMSI 2", geschrieben in Rust.
 
-### Omsi2Komsi (Main Plugin)
+## Omsi2Komsi (Haupt-Plugin)
+Omsi2Komsi ist eine Plugin-DLL, die Informationen (Geschwindigkeit, Lampen usw.) aus OMSI 2 liest und über eine serielle Schnittstelle (USB) mit dem KOMSI-Protokoll sendet.
+Infos zum Komso-Protokoll gibt es hier: https://github.com/thatzok/Komsi-Protocol
+Ein am USB-Anschluss angeschlossener Arduino/ESP32 oder ein ähnliches Gerät kann diese Nachrichten dann lesen und die Daten auf einem physischen Bus-Dashboard anzeigen (z. B. Geschwindigkeit auf einem Tachometer, Lampenbeleuchtung usw.).
 
-Omsi2Komsi is a plugin DLL that reads information (speed, lamps, etc.) from OMSI 2 and sends it to a serial port (USB) using the [KOMSI protocol](https://github.com/thatzok/Komsi-Protocol).
+### Verwendung
 
-An Arduino/ESP32 or similar device connected to the USB port can then read these messages and display the data on a physical bus dashboard (e.g., speed on a speedometer, lamp lighting, etc.).
+1. Kopiere sowohl `omsi2komsi.dll` als auch `omsi2komsi.opl` in das Verzeichnis "`plugins`" von OMSI 2.
+2. Bearbeite die Datei `omsi2komsi.opl` und ändern den `portname` auf den Anschluss, an dem der Arduino/ESP32 angeschlossen ist.
+3. Starte OMSI 2.
+4. Standardmäßig drücke **F10**, um die Sichtbarkeit des Logger-Fensters umzuschalten und Diagnosemeldungen anzuzeigen.
 
-#### Usage
+Die Konfiguration erfolgt über die Datei omsi2komsi.opl, die sich auch im Pluginverzeichnis "plugins" von OMSI 2 befinden muss.
+Aus der mitgelieferten Beispiel-Konfiguration sollten die Konfigurationsmöglichkeiten ersichtlich sein.
+Zum Debugging und Fehler suchen kann man das Programm auch ohne serielle Schnittstelle (serialportenabled = false) starten.
 
-1. Copy both `omsi2komsi.dll` and `omsi2komsi.opl` into the `plugins` directory of OMSI 2.
-2. Edit the `omsi2komsi.opl` file and change the `portname` to the one where your Arduino/ESP32 is connected.
-3. Start OMSI 2.
-4. By default, press **F10** to toggle the logger window visibility.
 
-The configuration is done via the `omsi2komsi.opl` file, which must be located in the same directory as the DLL.
+## OmsiLogger (Diagnosewerkzeug)
 
+OmsiLogger ist ein Diagnosewerkzeug, das Echtzeitwerte von OMSI 2-Variablen in einem Overlay-Fenster anzeigt und in eine Datei protokolliert.
+Es kann dazu dienen herauszufinden, welche OMSI 2 Variablen überhaupt bei bestimmten Bussen eine Funktion haben um diese dann später in der omsi2komsi.opl-Konfiguration zu verwenden.
+Es können bis zu 100 Variablen in die [varlist] eingetragen werden. Werden mehr eingetragen, werden diese ignoriert.
 
-### OmsiLogger
+### Verwendung
 
-OmsiLogger is a diagnostic tool that displays real-time values of OMSI 2 variables in an overlay window and logs them to a file.
+1. Kopiere `omsilogger.dll` und `omsilogger.opl` in das Verzeichnis "plugins" von OMSI 2.
+2. Bearbeite die Datei omsilogger.opl und trage da die OMSI 2 Variablen ein, die geprüft werden sollen.
+3. Starte OMSI 2.
+4. Standardmäßig drücke **F10**, um die Sichtbarkeit des Logger-Fensters umzuschalten und Diagnosemeldungen anzuzeigen.
+5. Wenn sich Variablenwerte ändern werden diese auch in eine Datei namens omsilogger_JJJJ-MM-TT.txt im OMSI 2-Verzeichnis protokolliert.
 
-#### Usage
+Die Konfiguration erfolgt über die Datei omsilogger.opl, die sich auch im Pluginverzeichnis "plugins" von OMSI 2 befinden muss.
+Aus der mitgelieferten Beispiel-Konfiguration sollten die Konfigurationsmöglichkeiten ersichtlich sein.
 
-1. Copy `omsilogger.dll` (compiled from the example) and `omsilogger.opl` into the `plugins` directory.
-2. Start OMSI 2.
-3. By default, press **F10** to toggle the logger window visibility.
-4. It will log the changed values defined in `omsilogger.opl` to a file named `omsilogger_YYYY-MM-DD.txt` in the OMSI 2 directory.
+Omsi2Komsi und OmsiLogger sollten nicht gleichzeitig im Pluginverzeichnis "plugins" von OMSI 2 installiert sein.
 
-The configuration file `omsilogger.opl` allows you to define the variables to monitor and the hotkey:
 
+**Viel Spaß!**
 
 
-Have fun!
-
-
-
-## License
-
-This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](LICENSE) for more details.
-
-You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
+## Lizenz
 
+Dieses Programm ist freie Software: Sie können es unter den Bedingungen der GNU General Public License, wie von der Free Software Foundation veröffentlicht, entweder gemäß Version 3 der Lizenz oder (nach Ihrer Option) jeder späteren Version weitergeben und/oder modifizieren.
+Dieses Programm wird in der Hoffnung verteilt, dass es nützlich sein wird, aber OHNE JEDE GEWÄHRLEISTUNG; sogar ohne die implizite Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK. Siehe die GNU General Public License für weitere Details.
+Sie sollten eine Kopie der GNU General Public License zusammen mit diesem Programm erhalten haben. Wenn nicht, siehe <https://www.gnu.org/licenses/>.