Update README.md

This commit is contained in:
Braedon 2021-12-28 09:48:11 -05:00 committed by GitHub
parent cec00281c4
commit 7d9657702a

View file

@ -1,9 +1,24 @@
## This project is still in development. There are NO public compiled releases (yet).
# Rhythm Heaven Mania
![image](https://user-images.githubusercontent.com/24588691/147578029-c0ca76eb-34a4-48ad-a27e-480cc3966b38.png)
(WIP) Fully playable, open source recreation of every rhythm heaven minigame with a built in level editor.
## WARNING!!!
If you're reading this line then this means that the project is in a very "hacky" state. Don't expect clean code or code that works at all.
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![youtube.com/starpelly](https://img.shields.io/badge/youtube-youtube.com%2Fstarpelly-red)](https://youtube.com/starpelly)
## Self-Building
#### Note: Mac-OS and Linux-based builds not tested.
Rhythm Heaven Mania's game engine is [Unity 2020.3.25f1](https://unity3d.com/unity/whats-new/2020.3.25),
and programmed with [Visual Studio 2022](https://visualstudio.microsoft.com/vs/).
### Dependencies (You may or may not have to install these)
* [Newtonsoft.Json-for-Unity](https://github.com/jilleJr/Newtonsoft.Json-for-Unity)
* [Starpelly](https://github.com/Starpelly/Starpelly)
* [DOTween](http://dotween.demigiant.com/)
## 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.