From 3a9bca96eda70a029159d9b6fc7bac48313ddd08 Mon Sep 17 00:00:00 2001 From: Michal Plichta Date: Fri, 31 Jan 2025 22:14:42 +0100 Subject: [PATCH] update spelling in documentation --- docs/about.md | 4 ++-- docs/planes.md | 10 +++++----- docs/upgrade.md | 4 ++-- docs/usage.md | 36 ++++++++++++++++++------------------ 4 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/about.md b/docs/about.md index bdb83479e..023c7c950 100644 --- a/docs/about.md +++ b/docs/about.md @@ -5,8 +5,8 @@ You are welcome [dcspy discord](https://discord.gg/SP5Yjx3) server. # Change Log [Version changes](https://github.com/emcek/dcspy/blob/master/CHANGELOG.md) -# Secuirity -[Secuirity information](https://github.com/emcek/dcspy/blob/master/SECURITY.md) +# Security +[Security information](https://github.com/emcek/dcspy/blob/master/SECURITY.md) # License [MIT License](https://github.com/emcek/dcspy/blob/master/LICENSE.md) diff --git a/docs/planes.md b/docs/planes.md index d8bc7a505..7a02e0ee1 100644 --- a/docs/planes.md +++ b/docs/planes.md @@ -23,7 +23,7 @@ Apache EUFD is to big to fit small, so is spited into 3 Modes. ![AH64DBLKII_49](https://user-images.githubusercontent.com/475312/174405106-68364682-e1e2-4977-b92e-e558cf97d133.png) * To enter this mode press **Button4** / **Up** * In this mode display warnings, cautions, and advisories, -* **Button1** / **Left** is used to cycle thru pages of warnings +* **Button1** / **Left** is used to cycle through pages of warnings * Press **Button4** / **Up** again to back to IDM Mode ### Button Map of EUFD Modes: @@ -78,10 +78,10 @@ Note: Push **Menu** and **Cancel** toggle cockpit button down, push it again tog ![Mi24P_21](https://user-images.githubusercontent.com/475312/215358829-2c3713a5-ecd3-4cae-a59c-c9fdc89c1863.png) ## F-16C Viper -* Button1 - IFF MASTER Knob - cycle thru OFF/STBY/LOW/NORM/EMER -* Button2 - IFF ENABLE Switch - cycle thru M1/M3 /OFF/ M3/MS -* Button3 - IFF M-4 CODE Switch - cycle thru HOLD/ A/B /ZERO -* Button4 - IFF MODE 4 REPLY Switch - cycle thru OUT/A/B +* Button1 - IFF MASTER Knob - cycle through OFF/STBY/LOW/NORM/EMER +* Button2 - IFF ENABLE Switch - cycle through M1/M3 /OFF/ M3/MS +* Button3 - IFF M-4 CODE Switch - cycle through HOLD/ A/B /ZERO +* Button4 - IFF MODE 4 REPLY Switch - cycle through OUT/A/B ## F-14A and B Tomcat * Button1 - RIO CAP Clear diff --git a/docs/upgrade.md b/docs/upgrade.md index 0abb22716..a22ab88d7 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -1,6 +1,6 @@ # DCSpy ## Single file download (basic/recommended way) -Just download latest file from [Releases](https://github.com/emcek/dcspy/releases/latest) +Download latest file from [Releases](https://github.com/emcek/dcspy/releases/latest) ## via uv (advanced way) To upgrade DCSpy to the latest version, open Command Prompt and type: @@ -23,5 +23,5 @@ If you have enable `Auto check DCS-BIOS` you do not need any manual steps. Every 1. Stop DCS World or at least exit mission. 2. Make sure setting **DCS-BIOS folder** is correct 3. Click **Check for updates** button in DCS-BIOS group, Note, new version in footer. -5. Click OK. +4. Click OK. ![image](https://github.com/emcek/dcspy/assets/475312/187f9d91-5464-4560-9308-405e37816562) diff --git a/docs/usage.md b/docs/usage.md index 3fbe91baa..4d9a155d5 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,7 +1,7 @@ # Starting ## Single file download (basic way) 1. Run Logitech Gaming Software (it allows accessing LCD) -2. Double click at downloaded file. +2. Double click at the downloaded file. 3. Click `Start` 4. LCD should update with dcspy basic info, waiting to connect to DCS 5. Run DCS and start any mission. @@ -11,7 +11,7 @@ 2. You can check with `uv` install tool inside user directory like `C:\Users\\AppData\Local\uv\tools\dcspy\Scripts` 3. You can drag and drop `dcspy.exe` or `dcspy_cli.exe` to desktop and make shortcut (with custom icon, you can find icon in installation directory i.e. `C:\Users\mplic\AppData\Local\uv\tools\dcspy\Lib\site-packages\dcspy\img`). * `dcspy.exe` - with open directly GUI window - * `dcspy_cli.exe` - additionally start console window (with logs) + * `dcspy_cli.exe` - additionally start a console window (with logs) 4. Double-click on dcspy icon or type `dcspy.exe`\`dcspy_cli.exe` from Command Prompt 5. Click `Start` 6. LCD should update with dcspy basic info, waiting to connect to DCS @@ -19,30 +19,30 @@ **Note:** DCS can already running, before starting LGS and or DCSpy. -**Note:** If you upgrade DCSpy before version 1.7.0 `dcspy.ico` and `config.yaml` were in data directory like `c:\python312\dcspy_data\` but location is deperched in Python if you still have it, you can safely delete it +**Note:** If you upgrade DCSpy before version 1.7.0 `dcspy.ico` and `config.yaml` were in data directory like `c:\python312\dcspy_data\` but location is deprecated in Python if you still have it, you can safely delete it # Mono vs. Color DCSpy do not use full potential of G19, which support full RGBA, 8-lines LCD. In contrast to mono devices (like G13, G15 and G510), which support mono, 4-lines LCD. ## LCD buttons -G19 has 7 buttons. +G19 has 7 buttons. In contrast to mono devices (like G13, G15 and G510) has only 4 buttons. -Way in which actions assign to button for G13 (4 buttons form left to right) are mapped to G19 looks: +Way in which actions assign to button for G13 (four buttons form left to right) are mapped to G19 looks: * G13 1st button -> G19 left button * G13 2nd button -> G19 right button * G13 3rd button -> G19 down button * G13 4th button -> G19 up button -Right now LCD buttons are hardcoded in DCSpy and its function depends on currently loaded aircraft. This will change in future. +Right now LCD buttons are hardcoded in DCSpy and its function depends on currently loaded aircraft. This will change in the future. ## G13, G15, G510 - Mono -mono, 4-lines LCD with only 4 buttons +mono, 4-lines LCD with only four buttons ![image](https://user-images.githubusercontent.com/475312/174407168-7db23a3f-3493-4a35-b898-ebb3a3ff839f.png) ![image](https://user-images.githubusercontent.com/475312/174407442-ed9c7d85-057d-4572-8316-3578721e4dab.png) ![image](https://user-images.githubusercontent.com/475312/174407530-b010691c-0895-4786-ad4e-8f98deeebb02.png) ## G19 - Color -full RGBA, 8-lines LCD with 7 buttons +full RGBA, 8-lines LCD with seven buttons ![image](https://user-images.githubusercontent.com/475312/174407299-d07e7ba5-d837-4af4-884a-7e20a48d676a.png) ## G-keys @@ -53,26 +53,26 @@ From DCSpy 3.0 it is possible to use all keyboard's G-Keys: * G15 v2 - 6 keys * G13 - 29 keys -You can assign almost any input controller from cockpit for aircraft supported by DCS-BIOS. Note: DCS-BIOS has to provide input protocol. +You can assign almost any input controller from a cockpit for aircraft supported by DCS-BIOS. Note: DCS-BIOS has to provide input protocol. -### How to setup: +### How-to setup: * Install Git: https://git-scm.com/download/win (any 64-Bit, default options should be fine) * Set **DCS-BIOS** folder ie. (D:/Users/wags/Saved Games/DCS.openbeta/Scripts/DCS-BIOS) * Set checked **Use live DCS-BIOS version** (can take 20+ sec) * Click **Start** and then **Stop** (in rare cases is needed) -* Open LGS, new profile should be added (current dcspy file name: ie. dcspy_cli_3.0.0) +* Open LGS, new profile should be added (current dcspy file name: i.e., dcspy_cli_3.0.0) ![image](https://github.com/emcek/dcspy/assets/475312/3145510c-ad8b-4fca-8fe6-596129d9a755) * Set this profile default and optionally persistent. Close LGS. ![image](https://github.com/emcek/dcspy/assets/475312/c56f61fb-bafb-4fd2-a2a9-549b5b1be990) * Go to **G-Keys** tab, additionally turn on **View** / **Show G-Keys** extra dialog -* Select plane from combo box up right corner +* Select plane from combo box in upright corner * assign any controllers to G-Key/Modes * Use save icon to save plane configuration # Configuration -All settings can be configured directly via GUI. However, more advanced users can change configuration file `config.yaml` file. It is located in user's AppData directory (e.g. `C:\Users\\AppData\Local\dcspy\config.yaml`). -This is simple file, most users do not need to touch it at all. Configuring DCSpy enable some powerful features of DCSpy. +All settings can be configured directly via GUI. However, more advanced users can change configuration file `config.yaml` file. It is located in user's AppData directory (e.g. `C:\Users\\AppData\Local\dcspy\config.yaml`). +This is a simple file, most users do not need to touch it at all. Configuring DCSpy enable some powerful features of DCSpy. ## Keyboards ![image](https://github.com/emcek/dcspy/assets/475312/3be6a62f-029e-43a2-b6ab-b2d4e06e8e9b) @@ -87,14 +87,14 @@ This is simple file, most users do not need to touch it at all. Configuring DCSp ### DCSpy * **autostart** - when set to `true` DCSpy start automatically. *possible values*: `true` or `false` -* **show_gui** - it allows showing or hiding GUI during start of DCSpy. When set to `false` DCSpy start automatically. +* **show_gui** - it allows showing or hiding GUI during the start of DCSpy. When set to `false` DCSpy start automatically. *possible values*: `true` or `false` * **check_ver** - check for new version during start of DCSpy. *possible values*: `true` or `false` * **dcs** - installation directory of DCS. By default it is set to `C:\Program Files\Eagle Dynamics\DCS World OpenBeta` ### DCS-BIOS -* **check_bios** - check for new version of DCS-BIOS during start of DCSpy. +* **check_bios** - check for a new version of DCS-BIOS during the start of DCSpy. *possible values*: `true` or `false` * **git_bios** - If set to `True` Git/Live version of DCS-BIOS with be used *possible values*: `true` or `false` @@ -105,10 +105,10 @@ This is simple file, most users do not need to touch it at all. Configuring DCSp *example value*: `D:\Users\wags\Saved Games\DCS.openbeta\Scripts\DCS-BIOS` ### Fonts -* **font_mono_xs** - size of extra small font for mono devices +* **font_mono_xs** - size of extreme small font for mono devices * **font_mono_s** - size of small font for mono devices * **font_mono_l** - size of large font for mono devices -* **font_color_xs** - size of extra small font for color devices +* **font_color_xs** - size of extreme small font for color devices * **font_color_s** - size of small font for color devices * **font_color_l** - size of large font for color devices * **font_name** - file name with TrueType font use in all devices