diff --git a/README.md b/README.md index 5d74dba..68d4e5b 100644 --- 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
+- A Feature-rich GUI Steam Workshop downloader for BO3 ([boiii client](https://github.com/Ezz-lol/boiii-free)) built using CustomTkinter
@@ -9,8 +9,8 @@
- - + +
@@ -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 + ## 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:\\lib\site-packages\customtkinter;customtkinter\" --add-data "c:\\lib\site-packages\CTkMessagebox;CTkMessagebox\" --add-data "c:\\lib\site-packages\CTkToolTip;CTkToolTip\"``` @@ -44,15 +54,22 @@ ### Notes: -. It saves your input except for workshop id
-. 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
-. Initializing SteamCMD for the first time could take some time depending on your internet speed
+* It saves your input except for workshop id
+* 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
+* Initializing SteamCMD for the first time could take some time depending on your internet speed
+* New item update window: Left click on an item (mouse3) -> will open the item in the browser (Steam Workshop)
+* 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)
+#### PS (Library tab):
+* Mouse1 -> copy id
+* Mouse2 (scroll wheel btn) -> Open item path in explorer
+* Mouse3 -> Copy path
+* Ctrl + Mouse 1 (after Mouse1) -> Append to clipboard -. Known bugs:
-. 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)
-. 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
-. 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](https://www.virustotal.com/gui/file/5ca1367a82893a1f412b59a52431e9ac4219a67a50c294ee86a7d41473826b14/detection)
+### Known bugs:
+* 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)
+* 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
+* 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](https://www.virustotal.com/gui/file/5ca1367a82893a1f412b59a52431e9ac4219a67a50c294ee86a7d41473826b14/detection)
### todos: - [x] add a menu that shows you current installed mods/maps