/Quaver

🎶 The ultimate community-driven, and open-source competitive rhythm game.

Primary LanguageC#Mozilla Public License 2.0MPL-2.0

Quaver

Build Status CodeFactor license

steam twitter discord blog website
Steam Store Page Follow Us On Twitter Join The Discord Read The Developer Blog Visit The Website

About

Quaver is a community-driven and open-source competitive vertical scrolling rhythm game with two game modes and online leaderboards. It also features an in-game editor and a flexible multiplayer mode.

It is also available on Steam Early Access for Windows, Mac, and Linux—making it one of the most accessible community-driven rhythm games to date.

Status

This project is currently under heavy development and is in a beta state, however it is extremely playable as a standalone game. Quaver still has a ton of work ahead of it and will continue to get better as time goes on with new features and bug fixes being added each day.

Features

Although there are many games like this, Quaver offers many unique features and expands on the ideas of its predecessors that make it much different. It is also heavily inspired by a variety of our favorite rhythm games.

  • Two Game Modes - Play the game with 4 keys or challenge yourself with 7. Each game mode has separate global and country leaderboards to compete on.

  • Global & Country Leaderboards - Compete with your country and the world for the highest scores and aim to be #1.

  • Ranked & Casual Multiplayer - Challenge up to 16 players in casual or competitive-oriented multiplayer battles. Multiplayer includes three game modes including Free-For-All, Teams, and Battle Royale.

  • Map Editor - Create your own maps to any of your favorite songs. Upload and share them with the world, and submit them for official ranking.

  • Advanced Skinning System - Completely customize your gameplay experience with the ability to create skins. Export and share your skins with friends or upload them to the Steam workshop.

  • Replays - Go back in time by watching your previous scores. Watch replays from other players around the world, or export your own and share them with your rivals.

  • Over 10+ Game Modifiers - Switch up the way you play by activating in-game modifiers. Customize the speed of the song, get rid of all the long notes, or even randomize the entire map!

  • Steam Achievements - Become a master of Quaver by completing challenges and earning achievements!

  • Play Maps From Other Games - Coming from a different game and miss all of your favorite maps? Quaver supports .osz, .sm, and .mc/.mcz files out of the box—with support for more games to be added in the future!

Building & Running

Getting started with Quaver development is extremely easy.

  • Install the .NET Core 3.1 SDK
  • Clone the Quaver repository and its submodules git clone --recurse-submodules https://github.com/Quaver/Quaver
  • Have Steam open and running
  • Build & run Quaver with dotnet run --project Quaver

Contributing

The best place to begin contributing to Quaver is through our Discord server, where all of our developers, community, and testers are located.

Any contributions can be made through opening a pull request. When contributing however, please keep in mind that there should only be one branch/pull request per feature. This means if your branch is titled my-new-feature, you shouldn't have any unrelated commits, and the same system is applied to pull requests. Please make sure to keep your pull requests short and concise.

If you are wanting to develop a feature with the goal of having it being in the Steam release, open up an issue first, so we can discuss if it is in the scope of what we are trying to accomplish.

When contributing, please remember to follow our code style, so the codebase is consistent across the board. If you have any issues with our approaches to structuring/styling our code, feel free to bring this up.

LICENSE

The Quaver game client is split up into submodules which are subject to their own individual licensing. Please see each submodule to view their respective license(s).

The code in this repository is released and licensed under the Mozilla Public License 2.0. Please see the LICENSE file for more information. In short, if you are making any modifications to this software, you must disclose the source code of the modified version of the file(s), and include the original copyright notice.

Please be aware that all game assets are released and covered by a separate license. This should be noted when using this software to create derivatives for commercial purposes. Please see the Quaver.Resources repository for further information regarding licensing.