quaver / z

The new real-time multiplayer, & chat server for Quaver.

Z

🌎 The new real-time login, multiplayer, & chat server for Quaver.

Z is one of many services that power Quaver and is the successor to Albatross.

This server handles any and all real-time game events such as:

• Client login & user sessions
• Multiplayer
• Spectator
• Chat
• Twitch Song Requests
• & any other real-time events

This application is being developed for internal use. As such, no support or proper documentation will be provided for the usage of this software.

Requirements

• MariaDB / MySQL
• Redis
• Steam API Key
• Steam Publisher API Key

Setup

1. Install Go 1.22 or later.
2. Clone the repository.
3. Copy config.example.json and make a file named config.json
4. Fill out the config file with the appropriate details.
5. If you do not have a Steam Publisher Account (you are not a Quaver developer), you can set bypass_steam_login to true in the config file. This should NOT be used in a production environment.
6. Navigate to the /cmd/server/ directory
7. Start the server with go run . or your method of choice.
8. The server is now available at ws://localhost:3000.

LICENSE

This software is licensed under the GNU Affero General Public License v3.0. Please see the LICENSE file for more information.

z's Issues

Add spectator chat channel

Add multiplayer / spectator chat webhook

Add Profanity Filter

Either disable it for usernames or we need to fix old/find new one.

There is few players that complained about it, one example is "WarpABoi" which gets censored to "Warpa*oi"

Cache multiplayer scores live in redis

Closing Quaver while in an lobby, it wont close

It has been few hours and its still available ingame, until someone joins and leaves.

Room gets disbanded status when tournament mode is on

Checking !mp debug says room has been disbanded. Unsure if this would cause issues but should still be saying false instead true.
This only happens if everyone has left the lobby.

Invited player should be removed from playersInvited list upon joining

This makes it so they can bypass the lobby password if they get kicked, and can join with anything typed in.

https://github.com/Quaver/Z/blob/main/multiplayer/game.go#L99

Add channels that normal users can't talk in

Fix multiplayer game invite not placing user in-game

Auto Host doesn't take into account disallowed game modes

Ending lobby match on disconnect should only happen if its 1v1

Larger lobbies should not end the gameplay if someone gets disconnected.

Erroneous state on client when spamming joining games

When clicking to join more than one time before the server sends you to the game, the server will send the join packet twice, causing the first MultiplayerGameScreen to exit with LeaveGame()

Error happens because game.RemovePlayer got called:

https://github.com/QiuFeng54321/Z/blob/906164ecd4e1271eb68b9752ca1bc1fbf1cf0e1d/multiplayer/game.go#L90

We can guard return here and make client directly enter game screen when CurrentGame is not null