etc/HeavenStudioPlus
0
0
Fork 0
mirror of https://github.com/RHeavenStudioPlus/HeavenStudioPlus.git synced 2024-11-22 17:45:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

Create Build Instructions (#215)

Browse source 
* Platform-Specific notes in the appropriate place

Add a link to the BUILD.MD

* Create BUILD.MD

* Rename BUILD.MD to BUILD.md

* Update README.md
This commit is contained in:
Saraistupid 2023-01-21 19:32:17 +02:00 committed by GitHub
parent d7655a1d3a
commit febae6db00
2 changed files with 32 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
BUILD.md Normal file
View file

@ -0,0 +1,24 @@
# Build instructions
### Prerequisites:
- git
- A Unity 2020.3.xx LTS version
- A Machine running Windows, Linux or MacOS
### Instructions:
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.
### 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.
```
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 unityhub
```
- If your MacOS build does not have libraries, make sure that all libraries are set to Any OS and Any CPU in their properties.

11
README.md
View file

@ -24,17 +24,22 @@
## Prebuilt Binaries
This project is still in development, so there are currently no release builds yet. GitHub Actions creates experimental builds on each commmit, but minimal support will be provided.
- [Windows](https://nightly.link/megaminerjenny/HeavenStudio/workflows/main/master/StandaloneWindows64-build.zip)
- [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.
## Self-Building
#### Note: MacOS and Linux-based builds are not fully tested, you may [experience bugs with audio-related tasks](https://github.com/megaminerjenny/HeavenStudio/issues/72).
#### Note: on MacOS, You need to [set the app as executable by yourself](https://cdn.discordapp.com/attachments/954121092564402207/1060769484278861844/IMG_6336.jpg).
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/).
Building tutorial: coming soon
Build Instructions: [BUILD.md](https://github.com/megaminerjenny/HeavenStudio/blob/buildmd/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.