HeavenStudioPlus/README.md
Saraistupid febae6db00 Create Build Instructions (#215)
* 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
2023-01-21 12:32:17 -05:00

45 lines
2.7 KiB
Markdown

## This project is still in development. There are NO public compiled releases (yet).
# Heaven Studio
(WIP) A tool to create playable Rhythm Heaven custom remixes, with many customization options.
<p>
<a href="https://discord.gg/2kdZ8kFyEN">
<img src="https://img.shields.io/discord/945450048832040980?color=5865F2&label=Heaven%20Studio&logo=discord&logoColor=white" alt="Discord">
</a>
</p>
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[Progress Spreadsheet](https://docs.google.com/spreadsheets/d/1NXxIeL4nsdjChrxAZTPpk20QOKEdQWGbXIhT4TclB6k/edit?usp=sharing)
[YouTube Channel](https://www.youtube.com/channel/UCAb3R-5qyXWOEj8B4vibhxQ)
[Bug Report Form](https://docs.google.com/forms/d/e/1FAIpQLSfu0p2ZjrfwwEvpLgJ4Hw-AAN3jh4QNSEk0U7mjDvwiIkoRAw/viewform?usp=pp_url)
![prCapture](https://user-images.githubusercontent.com/43734252/212429715-1971929f-fee1-442f-8ba2-694e1732590a.png)
## 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
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)
## 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.