v0.3.0 readme

2023-09-14 16:04:29 +01:00 · 2023-09-14 16:04:29 +01:00 · 2f5e6ce3c7
commit 2f5e6ce3c7
parent e8e28b2e6b
1 changed files with 30 additions and 13 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,5 @@
 # BOIIIWD
- A GUI Steam Workshop downloader for BO3 ([boiii client](https://github.com/Ezz-lol/boiii-free)) built using CustomTkinter <br>
+- A Feature-rich GUI Steam Workshop downloader for BO3 ([boiii client](https://github.com/Ezz-lol/boiii-free)) built using CustomTkinter <br>

 <div style="display: flex; justify-content: space-between;">
  <!-- Left Side -->
@ -9,8 +9,8 @@
  </div>
  <!-- Right Side -->
  <div style="flex: 1; margin-left: 5px;">
-    <img src="https://github.com/faroukbmiled/BOIIIWD/assets/51106560/781df268-0ce7-4872-aaef-cce9f1af9e72" width="400" />
-    <img src="https://github.com/faroukbmiled/BOIIIWD/assets/51106560/d54f59b3-1e9f-4042-914a-51afcd6f4c18" width="400" />
+    <img src="https://github.com/faroukbmiled/BOIIIWD/assets/51106560/76f74154-b239-4b39-a2af-fd6c4ecb4043" width="400" />
+    <img src="https://github.com/faroukbmiled/BOIIIWD/assets/51106560/229f2e70-b32b-4911-9a82-586e6dd55ae9" width="400" />
  </div>
 </div>

@ -20,13 +20,23 @@
 - If the exe is getting flagged as a virus by your ac it is obviously a false positive, if you still do not trust it you can [compile/freeze](#freezing) it yourself ([VirusTotal Scan](https://www.virustotal.com/gui/file/5ca1367a82893a1f412b59a52431e9ac4219a67a50c294ee86a7d41473826b14/detection))

 ## Usage (script):
- ```pip install -r requirements.txt``` -> use my modified [CTkToolTip](./CTkToolTip) for [v0.2.8](https://github.com/faroukbmiled/BOIIIWD/releases) and up
+- ```pip install -r requirements.txt``` -> use my modified [CTkToolTip](./CTkToolTip) and [CTkListbox](./CTkListbox) for [v0.2.8](https://github.com/faroukbmiled/BOIIIWD/releases) and up
 - ```python boiiiwd.py```
 - Slap in your workshop item link for example: "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" or just the id 3011930738)

+## Features:
+- Improves steamcmd's stability while downloading
+- Auto installs mods and maps to boiii
+- Queue -> download items in queue
+- Library tab -> lists your downloaded items
+- Item updater -> Checks your items for updates (redownloads them,no way for now to "update" them only) -> Under Library tab
+- Steam to boiii -> Item mover (moves items (mods,maps) from steam to boiii client) -> Under settings tab
+- Themes -> Under settings tab
+- Bunch of useful settings -> Under settings tab
+
 <a name="freezing"></a>
 ## Freezing into an exe (pyinstaller):
- ```pip install -r requirements.txt``` -> use my modified [CTkToolTip](./CTkToolTip) for [v0.2.8](https://github.com/faroukbmiled/BOIIIWD/releases) and up
+- ```pip install -r requirements.txt``` -> use my modified [CTkToolTip](./CTkToolTip) and [CTkListbox](./CTkListbox) for [v0.2.8](https://github.com/faroukbmiled/BOIIIWD/releases) and up
 - ```pip install pyinstaller```
 - ```pyinstaller --noconfirm --onefile --windowed --icon "ryuk.ico" --name "BOIIIWD" --ascii  "boiiiwd.py" --add-data "resources;resources" --add-data "c:\<python_path>\lib\site-packages\customtkinter;customtkinter\" --add-data "c:\<python_path>\lib\site-packages\CTkMessagebox;CTkMessagebox\" --add-data "c:\<python_path>\lib\site-packages\CTkToolTip;CTkToolTip\"```

@ -44,15 +54,22 @@

 <a name="notes"></a>
 ### Notes:
-. It saves your input except for workshop id <br>
-. If you do not know where to find your map in-game check this [video](https://youtu.be/XIQjfXXlgQs?t=260) out ,for mods find "mods" in the game's main menu <br>
-. Initializing SteamCMD for the first time could take some time depending on your internet speed <br>
+* It saves your input except for workshop id <br>
+* If you do not know where to find your map in-game check this [video](https://youtu.be/XIQjfXXlgQs?t=260) out ,for mods find "mods" in the game's main menu <br>
+* Initializing SteamCMD for the first time could take some time depending on your internet speed <br>
+* New item update window: Left click on an item (mouse3) -> will open the item in the browser (Steam Workshop) <br>
+* BOIIIWD requires having "boiiiwd_library.json" in the app's directory for the new features to work -> clicking on the library tab will generate the JSON file (please don't touch it) <br>
+#### PS (Library tab): <br>
+* Mouse1 -> copy id <br>
+* Mouse2 (scroll wheel btn) -> Open item path in explorer <br>
+* Mouse3 -> Copy path <br>
+* Ctrl + Mouse 1 (after Mouse1) -> Append to clipboard

-. Known bugs: <br>
-. Rare UI bug => instead of showing a warning message, its window goes invisible and leads to the whole ui becoming unclickable (end the task from task manager) <br>
-. Possible logic bugs related to the progress bar , sometimes it carries on progressing when you pressed stop => please raise an issue if this happens often <br>
-. If the exe is getting flagged as a virus by your ac it is obviously a false positive, if you still do not trust it you can [compile/freeze](#freezing) it yourself <br>
-. [VirusTotal](https://www.virustotal.com/gui/file/5ca1367a82893a1f412b59a52431e9ac4219a67a50c294ee86a7d41473826b14/detection) <br>
+### Known bugs: <br>
+* Rare UI bug => instead of showing a warning message, its window goes invisible and leads to the whole ui becoming unclickable (end the task from task manager) <br>
+* Possible logic bugs related to the progress bar , sometimes it carries on progressing when you pressed stop => please raise an issue if this happens often <br>
+* If the exe is getting flagged as a virus by your ac it is obviously a false positive, if you still do not trust it you can [compile/freeze](#freezing) it yourself <br>
+* [VirusTotal](https://www.virustotal.com/gui/file/5ca1367a82893a1f412b59a52431e9ac4219a67a50c294ee86a7d41473826b14/detection) <br>
  
 ### todos:
 - [x] add a menu that shows you current installed mods/maps