Giter VIP home page Giter VIP logo

quaver.wiki's Introduction

Quaver

GitHub Actions Workflow Status CodeFactor license

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 for Windows, Mac, and Linux—making it one of the most accessible community-driven rhythm games to date.

Building & Running

Getting started with Quaver development is extremely easy.

  • Install the .NET 6 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.

quaver.wiki's People

Contributors

a6st avatar adrriii avatar aiae avatar ajcdev avatar ayayaa-dev avatar cornerpin avatar cuckson avatar david-ottertun avatar electroyan avatar elitedreamer avatar fretzi avatar icedynamix avatar illuminati-craz avatar jaanjah avatar janko5 avatar jianshyydev avatar m666abc avatar magnusrick avatar makaiiart avatar nebneb0703 avatar pianoluigi avatar reyder95 avatar robby250 avatar sceptimis avatar swan avatar untitld avatar warp9000 avatar yalter avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

quaver.wiki's Issues

Coloring main categories and highlighting the currently selected category

On the left side is a list of bookmarks but you never see which one you selected. It's irritating. Could it be done so that after clicking on the "skin.ini" category, for example, it will be highlighted in yellow or blue? or for example main categories like start, faq, gameplay etc will be yellow and subcategories like skin.ini will be white by default but blue when clicked?

Something like this (colors can be different)
img

Wording addition on General Rules / Ranking Criteria

Currently it only says "use appropriate steam avatar" or "use an avatar that isn't NSFW", but it seems to be lack of in-depth category (such as age limitation or borderline how much it allows player to use image that contain slightly shows some spot in modest way).

To prevent things that we're not expecting in the future (since quaver will grow bigger community) I'd suggest to add some wording below (can be placed on below no. 6 of General Rules or on Ranking Criteria below dimension requirement)
"Steam avatar and Background on maps should be at least 13+ and can't be more than 18+ or SFW. Above 18+ should get content reviewer"

Plugins page does not teach how to install plugins

https://wiki.quavergame.com/docs/Editor/plugins

The wiki page jumps straight from "what are plugins?" to "creating your own plugin". It glosses over how to install plugins, which is what most people are likely to do. It may make sense to have a separate section for this before plugin creation is mentioned, since those interested in developing their own plugins are more likely to scroll down anyway.

I wouldn't expect the instructions to need to be very in-depth either, just something directing users to "copy to Quaver\Plugins" should probably suffice. As it is currently, they have to infer that from the plugin creation text, which isn't very user-friendly.

JudgementHitBurstScale description in skin.ini should be rewritten on the wiki

JudgementHitBurstScale description is currently "The scale of the judgement hit bursts to change the size of it" and its possible value is specified as a Float, however this value should be changed to Integer and the description should describe how the value is read as x/100. (50 means 50% size). This caused confusion while I was changing this value and should be rewritten.

Currently:
image

Suggested:
image

Provide better context for the Source field in Ranking Criteria

Currently, the ranking criteria page has only the two following lines regarding the source field:

  • The artist and title must be romanized. However, non-romanized characters are allowed to be used in source and tags.
  • The artist, title and source must not repeat in tags. However, romanizing or translating the source in tags is encouraged, in case it’s relevant.

A common issue new mappers have is that they do not understand what the source field should actually have filled in with. The literal definition of source would suggest a [youtube] link works too. Experienced mappers, especially those coming from osu, know that the source field should contain the Album, game, anime, show, ect

However, there is no such indication on ranking criteria, so this is an easy to follow, yet unwritten thing that people can miss.

Please add some language to the page so people can be aware of how to fill in the source field properly. It doesn't feel good to get rejected by criteria that was not properly defined in the first place.

OAuth usage is unclear

As the title says, I have no clue why I would use the OAuth implementation as it isn't used for anything (as far as I can see from the docs), the only thing I can think of is downloading mapsets, which I have no clue also how to download (seriously, let me download mapsets from the server instead of from the web via API). If this could be cleared up, I would really appreciate it.

Link icon copy to clipboard

chrome_9T8b2HAavd
Drives me nuts that clicking this doesn't copy to clipboard, have to right click -> copy link or copy from URL bar.

Some hotkeys like ctrl+p aren't documented anywhere

I wanted to learn how to turn off the background music but couldn't find out how. On Discord I learned about the hotkey ctrl+p for doing this. This hotkey is not documented in the ingame options nor on the wiki. This hotkey and others like it should be documented.

Add new options category for all in-game shortcuts

Is your feature request related to a problem? Please describe.
Since the update 0.12, new shortcuts have appeared (ctrl + o for options, right click for back in song selections, etc) but those not reading the patchnotes do not know it, and there may be other shortcuts already integrated in game that we do not know

Describe the solution you'd like
Add a new category of options dedicated to all the shortcuts of the game, which would be fully configurable for example to add or remove a key from the option combination

Example: Ctrl + o for options would become Ctrl + o + p, or just ctrl depending on the configuration the player chooses

Misspelling in Ranking Criteria's Guidelines

The word "instruments" is misspelled in the Guidelines section of the Ranking Criteria page.

Your map should generally make use of layering. - Mapping to different intstruments in the song will make your map reflect the music more.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.