This commit is contained in:
Ryuk 2023-08-27 20:48:18 +01:00 committed by GitHub
parent 7eec058374
commit 90f3f5993d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,33 +9,47 @@
## Usage (exe): ## 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) - 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)
- That's it slap in your workshop item link or just the id then hit Download and wait for it to finish, when it does just launch your game (Please check [Notes](#notes) before you ask anything) - That's it slap in your workshop item link or just the id then hit Download and wait for it to finish, when it does just launch your game (Please check [Notes](#notes) before you ask anything)
- 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
## Usage (script): ## Usage (script):
- ```pip install -r requirements.txt``` - ```pip install -r requirements.txt```
- ```python boiiiwd.py``` - ```python boiiiwd.py```
- Slap in your workshop item link for example: "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" or just the id 3011930738) - Slap in your workshop item link for example: "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" or just the id 3011930738)
<a name="freezing"></a>
## Freezing into an exe (pyinstaller): ## Freezing into an exe (pyinstaller):
- ```pip install -r requirements.txt``` - ```pip install -r requirements.txt```
- ```pip install pyinstaller``` - ```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\"``` - ```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\"```
## Queue tab (beta)
- added Queue tab which has a text field that you can slap in workshop ids/links in 2 formats for example:<br>
```3010399939,2976006537,2118338989,2113146805``` or <br>
```3010399939
2976006537
2118338989
2113146805
```
<a name="notes"></a> <a name="notes"></a>
### Notes: ### Notes:
. It saves your input except for workshop id <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> . 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> . Initializing SteamCMD for the first time could take some time depending on your internet speed <br>
. If the download fails when getting big maps its SteamCMD's fault, still working on a workaround <br>
. Known bugs: <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> . 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> . 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>
### todos: ### todos:
- [x] add a menu that shows you current installed mods/maps - [x] add a menu that shows you current installed mods/maps
- [x] fix the progress bar => progress bar logic based on an estimation - [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 - [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 - [x] 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?) - [ ] add an option to login with your account => delayed (do we really need it?)
### Themes: ### Themes: