Update README.md

This commit is contained in:
AstrlJelly 2024-05-16 18:41:25 -04:00
parent 4ce1c323ef
commit f8f4d77039

View file

@ -1,6 +1,7 @@
# Heaven Studio
# Heaven Studio+
(WIP) A tool to create playable Rhythm Heaven custom remixes, with many customization options.
This is a fork of Heaven Studio, made to incorporate a wider range of fangames.
<p>
<a href="https://discord.gg/2kdZ8kFyEN">
@ -10,40 +11,28 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[itch.io Page](https://rheavenstudio.itch.io/heaven-studio)
[Documentation](https://rheavenstudio.github.io/)
![image](https://github.com/RHeavenStudio/HeavenStudio/assets/43734252/c32ef9a3-2fd1-40df-b088-968950b2adab)
![image](https://github.com/RHeavenStudioPlus/HeavenStudioPlus/assets/43734252/c32ef9a3-2fd1-40df-b088-968950b2adab)
## Prebuilt Binaries
Full releases are published on our [itch.io page](https://rheavenstudio.itch.io/heaven-studio). GitHub Actions creates experimental builds on each commmit, but minimal support will be provided.
### Alpha builds
These builds target future patches / minor releases and thus do not include some of the features from Nightly.
- [Windows](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/release_1_patches/StandaloneWindows64-build.zip)
- [Linux](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/release_1_patches/StandaloneLinux64-build.zip)
- [MacOS](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/release_1_patches/StandaloneOSX-build.zip)
There are currently no plans for stable or alpha releases.
### Nightly builds
These builds include experimental new features that target future major releases.
- [Windows](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/master/StandaloneWindows64-build.zip)
- [Linux](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/master/StandaloneLinux64-build.zip)
- [MacOS](https://nightly.link/RHeavenStudio/HeavenStudio/workflows/build/master/StandaloneOSX-build.zip)
- [Windows](https://nightly.link/RHeavenStudioPlus/HeavenStudioPlus/workflows/build/master/StandaloneWindows64-build.zip)
- [Linux](https://nightly.link/RHeavenStudioPlus/HeavenStudioPlus/workflows/build/master/StandaloneLinux64-build.zip)
- [MacOS](https://nightly.link/RHeavenStudioPlus/HeavenStudioPlus/workflows/build/master/StandaloneOSX-build.zip)
#### Important Notes:
- On MacOS and Linux builds you may [experience bugs with audio-related tasks](https://github.com/RHeavenStudio/HeavenStudio/issues/72), but in most cases Heaven Studio works perfectly.
- On MacOS and Linux builds you may [experience bugs with audio-related tasks](https://github.com/RHeavenStudio/HeavenStudio/issues/72), but in most cases Heaven Studio+ works perfectly.
## Self-Building
Heaven Studio is made in [Unity 2021.3.21](https://unity.com/releases/editor/whats-new/2021.3.21),
Heaven Studio+ is made in [Unity 2021.3.21](https://unity.com/releases/editor/whats-new/2021.3.21),
and programmed with [Visual Studio Code](https://code.visualstudio.com/).
Build Instructions: [BUILD.md](https://github.com/megaminerjenny/HeavenStudio/blob/master/BUILD.md) (or the more maintained [documentation page](https://rheavenstudio.github.io/docs-contributing/setup/introduction))
(Outdated) Build Instructions: [BUILD.md](https://github.com/RHeavenStudioPlus/HeavenStudioPlus/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 free community project available for others to use and contribute to, without charge. Source code is licensed under the MIT license.