HeavenStudio/README.md

# 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)

[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)


## 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)

### 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)


#### 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.


## Self-Building

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))

## 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.
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`# Heaven Studio`
Update README.md 2021-12-28 14:48:11 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`(WIP) A tool to create playable Rhythm Heaven custom remixes, with many customization options.`
Update README.md 2021-12-19 04:14:19 +00:00
Update discord button in README 2022-02-12 21:43:42 +00:00			`<p>`
Update README.md 2022-02-22 00:15:24 +00:00			`<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">`
Update discord button in README 2022-02-12 21:43:42 +00:00			`</a>`
			`</p>`
Add discord link to README 2022-01-28 07:16:48 +00:00
Update README.md 2022-02-12 21:46:49 +00:00			`[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)`

Update README.md 2023-12-26 06:05:18 +00:00			`[itch.io Page](https://rheavenstudio.itch.io/heaven-studio)`
added bug report link 2022-06-30 04:49:02 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`[Documentation](https://rheavenstudio.github.io/)`
Update README.md 2023-01-13 22:19:35 +00:00
Update README.md 2023-12-26 06:05:18 +00:00			`![image](https://github.com/RHeavenStudio/HeavenStudio/assets/43734252/c32ef9a3-2fd1-40df-b088-968950b2adab)`

Update README.md 2021-12-28 14:48:51 +00:00
Update README.md 2021-12-28 14:48:11 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`## Prebuilt Binaries`
minor spelling mistake explodes 2024-01-16 02:03:39 +00:00			`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.`
Link github actions artifacts on readme 2022-04-10 23:51:42 +00:00
Update README.md (#661) 2024-01-28 03:49:50 +00:00			`### Alpha builds`
			`These builds target future patches / minor releases and thus do not include some of the features from Nightly.`
oups (readme update) 2024-01-16 02:03:09 +00:00			`- [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)`
Update README: - Fix links to new workflows - Add release_1 builds - Remove note about Linux/Mac builds being broken 2023-06-19 16:24:18 +00:00
			`### Nightly builds`
Update README.md (#661) 2024-01-28 03:49:50 +00:00			`These builds include experimental new features that target future major releases.`
Update README: - Fix links to new workflows - Add release_1 builds - Remove note about Linux/Mac builds being broken 2023-06-19 16:24:18 +00:00			`- [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)`

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 17:32:17 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`#### Important Notes:`
Update README.md relink issue 2023-04-20 17:44:10 +00:00			`- 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.`
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 17:32:17 +00:00
Link github actions artifacts on readme 2022-04-10 23:51:42 +00:00
Update README.md 2021-12-28 14:48:11 +00:00			`## Self-Building`
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 17:32:17 +00:00
Update unity version in readme.md 2023-04-02 02:46:17 +00:00			`Heaven Studio is made in [Unity 2021.3.21](https://unity.com/releases/editor/whats-new/2021.3.21),`
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`and programmed with [Visual Studio Code](https://code.visualstudio.com/).`
Update README.md 2021-12-21 00:29:34 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`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))`
social links 2022-02-03 00:35:22 +00:00
Revert "Misc. Fixes and Tweaks (#377)" (#380) This reverts commit f9906b50a5b109fbb745ff0888efaea03a4d1d1e. 2023-04-02 02:28:23 +00:00			`## Other information`
Change Project License to MIT (#700) * license change replace unneeded package * reword this 2024-02-16 06:17:16 +00:00			`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.`