From 0d7999ed788fc556df5c07bc64a0db8273d512e1 Mon Sep 17 00:00:00 2001
From: Ryuk <51106560+faroukbmiled@users.noreply.github.com>
Date: Sat, 19 Aug 2023 01:26:01 +0100
Subject: [PATCH] v0.2.0
---
README.md | 29 ++++++++++++++++++++---------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index bd18d4e..6dfcbf4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
# BOIIIWD
-- A GUI Steam Workshop downloader meant for BO3 ([boiii client](https://github.com/Ezz-lol/boiii-free)) built using PyQt5
-![image](https://github.com/faroukbmiled/BOIIIWD/assets/51106560/d66a09bf-9601-4443-a08e-217721671adb)
+- A GUI Steam Workshop downloader meant for BO3 ([boiii client](https://github.com/Ezz-lol/boiii-free)) built using CustomTkinter
+
+
+
+
+
+
## Usage (exe):
- Run [BOIIIWD.exe](https://github.com/faroukbmiled/BOIIIWD/releases/latest/download/Release.zip) and use it (it'll ask you to download steamcmd within the app if not found)
@@ -11,20 +16,26 @@
- ```python boiiiwd.py```
- Slap in your workshop item link for example: "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" or just the id 3011930738)
-## Compiling into an exe (pyinstaller):
+## Freezing into an exe (pyinstaller):
+- ```pip install -r requirements.txt```
- ```pip install pyinstaller```
-- ```pyinstaller --noconfirm --onefile --windowed --icon "ryuk.ico" --name "BOIIIWD" --ascii "boiiiwd.py"```
+- ```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\"```
### Notes:
. It saves your input except for workshop id
-. Excuse the progress bar its pretty shit atm, will be working on it
. 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
. If the download fails when getting big maps its SteamCMD's fault, still working on a workaround
+. Known bugs:
+. Rare UI bug => instead of showing a warning message it just does invisible that leads to the whole window 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
+
### todos:
-- [ ] add a menu that shows you current installed mods/maps
-- [ ] add an option to login with your account (for better download stability apparently)
-- [ ] fix the progress bar (dont know how still, steamcmd sucks in some ways)
-- [ ] other improvements regarding the download (steamcmd likes to fail sometimes for no reason)
+- [x] add a menu that shows you current installed mods/maps
+- [x] fix the progress bar => progress bar logic based on an estimation
+- [x] other improvements regarding the download (steamcmd likes to fail sometimes for no reason) => added a way to keep looping when steamcmd crashes and it will eventually finishes
+- [ ] add a queue window that you can slap in a bunch of items to download sequentially and or simultaneously
+- [ ] add an option to login with your account => delayed (do we really need it?)
+