A cross-platform community rhythm game design to be not just a rhythm game, but will be a rhythm game that has a story and some other gameplay elements that you not found in other rhythm games.
The game is currently under heavy development, most gameplay elements have been designed but still need polishing but aren't nowhere usable for now.
Current development plans are available here:
Here is the list of design documentation for Renako (each Figma file have many pages in them):
Note : In styling assets and design documentation, there are some "guidelines" that need to be followed when designing on both UX, UI and assets. Include the game's start lore too.
The following items are required to be installed on your computer in order to develop Renako:
- .NET 6 SDK
- The use of a C# IDE (Rider, Visual Studio) is highly recommended to browse through the codebase.
For mobile platforms, you will need to run sudo dotnet workload restore to install Android and iOS workloads to build the project in mobile platforms.
Getting started with developing Renako is as follows:
git clone https://github.com/HelloYeew/renako
cd renakocd Renako.Desktop
# restore nuget packages for the solution
dotnet restore
# run the game with the debug profile
dotnet run
# if you ever want to run the game with the release profile
# for performance testing, using the release profile
dotnet run -c:Releasecd Renako.Game.Tests
# restore nuget packages for the solution
dotnet restore
# run the visual tests with the debug profile
dotnet run
# run unit tests
dotnet testContributing in the form of pull request, suggestions or bug reports via issues are welcome. If interested to touch on the game's design as most things are already designed, please contact HelloYeew (me@helloyeew.dev) beforehand working on designing.
This project is licensed under the MIT license. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.