From 84ac8429af1bcea411c208b676d2cb79117e900c Mon Sep 17 00:00:00 2001
From: Saraistupid <37207067+Saraistupid@users.noreply.github.com>
Date: Mon, 23 Jan 2023 16:58:58 +0200
Subject: [PATCH] Compress the prebuilt binaries as tar (#226)

* Update main.yml

* I'M SO SO SO FUCKING STUPID

* Update README.md

* Add installing git instructions

* Update BUILD.md

* Update BUILD.md

* Update README.md

* Just in case because I don't trust Mac users

* Add unity installation instrucitons

* Update README.md
---
 .github/workflows/main.yml | 12 ++++++---
 BUILD.md                   | 50 ++++++++++++++++++++++++++++++++------
 README.md                  |  9 ++++---
 3 files changed, 55 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index bd40d7d0..0bfa6a81 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -48,9 +48,13 @@ jobs:
           buildName: Heaven Studio
           buildsPath: build
           targetPlatform: ${{ matrix.targetPlatform }}
-
-      # Output
-      - uses: actions/upload-artifact@v2
+          
+      - name: Tar files
+        run: tar -cvf ${{ matrix.targetPlatform }}.tar ./build/${{ matrix.targetPlatform }}
+        
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
         with:
           name: ${{ matrix.targetPlatform }}-build
-          path: ./build/${{ matrix.targetPlatform }}/
+          path: ${{ matrix.targetPlatform }}.tar
+
diff --git a/BUILD.md b/BUILD.md
index 8afd5548..e7afd981 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -1,20 +1,54 @@
 # Build instructions
 
-### Prerequisites:
-- git
+## Prerequisites:
+- git (see below to know how to install git)
 - A Unity 2020.3.xx LTS version
 - A Machine running Windows, Linux or MacOS
 
-### Instructions:
+## Installing git:
+#### Windows
+1. Grab the installer from [here](https://git-scm.com/download/win).
+2. Follow the usual installation process.
+3. When you reach the step where it asks about PATH enviornment in the installer, choose "Use Git from the Windows Command Prompt".
+4. Now open CMD/Command Prompt/Windows Terminal to use git.
+
+#### Mac
+1. Open the terminal.
+2. Install brew using
+```
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+3. After it finishes installing, install git using
+```
+sudo brew install git
+```
+
+#### Linux
+1. Look up instructions for your distro online.
+
+## Installing Unity:
+1. If you are on Windows or MacOS, download [Unity Hub](https://unity.com/download), on Linux just follow instructions on how to install Unity Hub [here](https://docs.unity3d.com/hub/manual/InstallHub.html#install-hub-linux) (or look up instructions online if your distro isn't mentioned in that page).
+2. Login with your Unity account (or create one if you haven't yet).
+3. Choose a Personal license.
+4. From the menu on left, go to "Installs".
+5. Press "Install Editor".
+6. Install the 2020.3.xx "Long Time Support (LTS)" version. 
+
+## Building Heaven Studio:
 1. Clone the repository to your machine
 ```
 git clone https://github.com/megaminerjenny/HeavenStudio.git
 ```
-2. Open Unity 2020.3.xx LTS
-3. Load the HeavenStudio repository you just cloned to Unity
-4. After Unity loads, Build AssetBundles by going to Assets -> Build AssetBundles
-5. After Building AssetBundles is done, build the game itself by going to File -> Build Settings -> Build
-6. And done, you now have built the game for your current platform.
+Note: It should clone to the home directory on your machine by default (on Windows that's your main user's folder, on MacOS that's the folder you access by pressing Shift + Command + H in Finder).
+
+2. Open Unity Hub.
+3. Go to "Projects" from the menu on left.
+4. Press "Open" in the top right.
+5. Select the Heaven Studio repository you just cloned in step 1, if you do not know where it is, see the note in step 1.
+6. After Unity loads, Build AssetBundles by going to Assets -> Build AssetBundles.
+7. After Building AssetBundles is done, build the game itself by going to File -> Build Settings -> Build.
+8. And done, you now have built the game for your current platform.
+
 
 ### Platform-specific notes:
 - If you get "empty errors" on Linux, run Unity Hub using the following command and load the Unity project through it. This is a general problem with Unity for some users on some distros such as Arch Linux.
diff --git a/README.md b/README.md
index d25a206f..ad129be9 100644
--- a/README.md
+++ b/README.md
@@ -29,9 +29,10 @@ This project is still in development, so there are currently no release builds y
 - [Linux](https://nightly.link/megaminerjenny/HeavenStudio/workflows/main/master/StandaloneLinux64-build.zip)
 - [MacOS](https://nightly.link/megaminerjenny/HeavenStudio/workflows/main/master/StandaloneOSX-build.zip)
 #### Important Notes:
-- MacOS and Linux-based builds are not fully tested, you may [experience bugs with audio-related tasks](https://github.com/megaminerjenny/HeavenStudio/issues/72).
-- on MacOS, you need to [set the app as prebuilt binary executable by yourself](https://cdn.discordapp.com/attachments/954121092564402207/1060769484278861844/IMG_6336.jpg).
-- Linux prebuilt binaries **ARE BUGGY** (AssetBundles do not get built), please build the project yourself instead.
+- The prebuilt binaries are compressed in tar format, you may need to use 7-Zip or WinRAR on Windows to extract them.
+- On MacOS and Linux builds you may [experience bugs with audio-related tasks](https://github.com/megaminerjenny/HeavenStudio/issues/72), but in most cases Heaven Studio works perfectly.
+- On MacOS you'll need to have Discord open in the background for now, there's a bug that causes the DiscordSDK library to crash when the rich presence is updated while Discord is not open in the background.
+- MacOS and Linux prebuilt binaries **ARE BUGGY** (AssetBundles do not get built causing some minigames as KarateMan to not render correctly), please build the project yourself instead using the instructions below.
 
 
 ## Self-Building
@@ -39,7 +40,7 @@ This project is still in development, so there are currently no release builds y
 Heaven Studio is made in [Unity 2020.3.25f1](https://unity3d.com/unity/whats-new/2020.3.25),
 and programmed with [Visual Studio Code](https://code.visualstudio.com/).
 
-Build Instructions: [BUILD.md](https://github.com/megaminerjenny/HeavenStudio/blob/buildmd/BUILD.md)
+Build Instructions: [BUILD.md](https://github.com/megaminerjenny/HeavenStudio/blob/master/BUILD.md)
 
 ## Other information
 Rhythm Heaven is the intellectual property of Nintendo. This program is NOT endorsed nor sponsored in any way by Nintendo. All used properties of Nintendo (such as names, audio, graphics, etc.) in this software are not intended to maliciously infringe trademark rights. All other trademarks and assets are property of their respective owners. This is a community project and this is available for others to use according to the GPL-3.0 license, without charge.