From 7f079cdeeee8b9d55a4939a98c5265ad43164714 Mon Sep 17 00:00:00 2001 From: Alex Jefferys Date: Sat, 11 Mar 2023 13:50:25 -0500 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4bd0e3204..5121dc09a 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,25 @@ ![Gif of YARG](gif.gif) -# 📥 Download - -[Click here](https://github.com/EliteAsian123/YARG/releases) to view all releases. +# 📥 Downloading and Playing + +Windows: +1. [Click here](https://github.com/EliteAsian123/YARG/releases) to view all releases. +2. Download the lastest zip file by clicking on the "Assets" dropdown and then clicking on `YARG_vX.X.X.zip`. +3. Extract the contents of the zip file by right clicking it and pressing "Extract All..." +4. Click "Extract". +5. Open the extracted folder and double-click `YARG.exe` (if you don't have file extensions on, it is called just `YARG`) +6. You may get a "Windows protected your PC" error. This is because not many people have ran the program before, so Windows does not know if it is harmful or not. Click on "More info" and then "Run anyway" to run YARG anyways. If you don't trust me, please feel free to scan the folder with an anti-virus. Please note that some anti-viruses may have the same problem as Windows. +7. Once you load in, click on "SETTINGS" +8. Then, choose your song folder. You can browse folder by click on the `B`. +9. Once you've chosen your folder, click on "Select Folder". Please be sure that the folder has at least one song in it. +10. Next click on "ADD/EDIT PLAYERS". This part is a little scuffed still. + 1. Click on "Add Player" + 2. Then click on the dropdown box and select the device you will be playing with. + 3. Click on what type of instrument you will be playing with (i.e. "Five Fret", "Microphone", etc.) + 4. Depending on the input type, you may have to bind keys on the very right side. To do this, click on each button and press the key of choice on your controller. +11. Finally, click on "QUICK PLAY". YARG will cache all of the files into a `yarg_cache.json` file in the folder you chose. Doing this may take a while depending on the amount of songs you have. If you ever add more songs, **be sure** to go to "SETTINGS" and then click on "Refresh Cache". This will add the new songs into "QUICK PLAY". +12. Have fun! # 🛡️ License