Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/make_docs' into make_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emcek committed Aug 12, 2024
2 parents 92beb06 + 0c729bf commit 80e19e9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ DCSpy uses multicast UDP to receive/send data from/to the DCS-BIOS, as describe

Main modules of DCSpy:

* `run.py` main script: it starts GUI in Qt6/PySide6
* `starter.py` responsible to initialise DCS-BIOS parser, Logitech G13/G15/G510 Mono handler and G19 Color handler, as well as running connection to DCS
* `log.py` dumb simple logger configuration
* `logitech.py` handling Logitech keyboards with LCD and buttons, loading dynamically aircraft used in DCS
* `aircraft.py` define all supported aircraft with details how and what display from DCS, draws bitmap that will be passed to LCD keyboard handler and returns input data for buttons
* `dcsbios.py` BIOS protocol parser and two buffers to fetching integer and string values `IntegerBuffer` and `StringBuffer` respectively.
* `qt_gui.py` GUI with widgets, layouts and events. It allows configuring DCSpy as well
* `utils.py` various useful tools - load and save config, check an online version, download file, update DCS-BIOS using git, etc.
* `models.py` pydantic models of internal data structures, some additional enums and other types definition used across DCSpy
* `sdk` python interface for Logitech C/C++ libraries to access keyboard LCD, G-keys and LED backlight
* `run.py` main script: it starts GUI in Qt6/PySide6
* `starter.py` responsible to initialise DCS-BIOS parser, Logitech G13/G15/G510 Mono handler and G19 Color handler, as well as running connection to DCS
* `log.py` dumb simple logger configuration
* `logitech.py` handling Logitech keyboards with LCD and buttons, loading dynamically aircraft used in DCS
* `aircraft.py` define all supported aircraft with details how and what display from DCS, draws bitmap that will be passed to LCD keyboard handler and returns input data for buttons
* `dcsbios.py` BIOS protocol parser and two buffers to fetching integer and string values `IntegerBuffer` and `StringBuffer` respectively.
* `qt_gui.py` GUI with widgets, layouts and events. It allows configuring DCSpy as well
* `utils.py` various useful tools - load and save config, check an online version, download file, update DCS-BIOS using git, etc.
* `models.py` pydantic models of internal data structures, some additional enums and other types definition used across DCSpy
* `sdk` python interface for Logitech C/C++ libraries to access keyboard LCD, G-keys and LED backlight
2 changes: 1 addition & 1 deletion docs/dcspy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
::: dcspy
options:
members:
- get_config_yaml_item
- get_config_yaml_item
1 change: 0 additions & 1 deletion docs/key.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
::: dcspy.sdk.key_sdk

2 changes: 1 addition & 1 deletion docs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
options:
members:
- DllSdk
- load_dll
- load_dll

0 comments on commit 80e19e9

Please sign in to comment.