From 638cfc7262ed29d24b334d29b1997ce90300f0a7 Mon Sep 17 00:00:00 2001 From: Ryuk <51106560+faroukbmiled@users.noreply.github.com> Date: Tue, 1 Aug 2023 20:04:36 +0100 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 86711e2..047f4a6 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,23 @@ - A GUI Steam Workshop downloader meant for BO3 (boiii client) built using PyQt5
![image](https://github.com/faroukbmiled/BOIIIWD/assets/51106560/2395fe6d-a92e-4ac5-93d2-4b42130f700c) -## release: +## Usage (exe): - (optional) Download and Run [steamcmd.exe](https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip) to initialize it first (in the same dir as the script/exe) -> Should only be done once -- Run [BOIIIWD.exe](https://github.com/faroukbmiled/BOIIIWD/releases/download/v0.1.2/Release.zip) and use it (it'll ask you to download steamcmd if not found) - -## Pre Usage: -- Place [SteamCMD](https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip) in the script's folder, and execute it to initiate SteamCMD. - -## Usage: +- Run [BOIIIWD.exe](https://github.com/faroukbmiled/BOIIIWD/releases/download/v0.1.2/Release.zip) and use it (it'll ask you to download steamcmd within the app if not found) +- That's it put in your map/mod workshop id then hit Download and wait for it to finish, when it does just launch your game (Please check [Notes](#notes) before you ask something) + +## Usage (script): - ```pip install -r requirements.txt``` - ```python boiiiwd.py``` -- to get a workshop id look at the link and get the id from it lol (For example: this workshop link "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" 3011930738 would be the workshop id) +- To get a workshop id look at the link and get the id from it lol (For example: this workshop link "https://steamcommunity.com/sharedfiles/filedetails/?id=3011930738" 3011930738 would be the workshop id) +* ![image](https://github.com/faroukbmiled/BOIIIWD/assets/51106560/79b7a4f8-894e-4d50-a885-eabed6e5be4e) ## Compiling into an exe (pyinstaller): - ```pip install pyinstaller``` - ```pyinstaller --noconfirm --onefile --windowed --icon "ryuk.ico" --name "BOIIIWD" --ascii "boiiiwd.py"``` - + + ### Notes: -. It saves your input except workshop id
-. Excuse the progress bar its pretty shit atm +. 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