wavebreaker-rs

EXTREMELY WIP!! (Yes, so much so that it's worth two exclamation marks!!)

This is a custom server for Dylan Fitterer's game Audiosurf.

The goal of this endeavour is to have at least feature parity with the TypeScript version, which is currently running in production at https://wavebreaker.arcadian.garden. Once this goal is reached and everything is working after a public test, the TypeScript version will be replaced with this.

Config example (Wavebreaker.toml), usable with the example docker-compose.yml:

[main]
address = "0.0.0.0:1337"
database = "postgres://postgres:wvbr_testpw@db"
redis = "redis://valkey"
# Meilisearch is optional, Wavebreaker works without it but it's needed for search
meilisearch_url = "http://localhost:7700"
meilisearch_key = "DANCE_DELIGHTFUL_IT_FEELS_SO_RIGHT"
# How often to sync songs with Meilisearch.
# written in cron's schedule format
song_sync_schedule = "0 */10 * * * *"
# Same but with user sync
# It also supports plain english, using https://crates.io/crates/english-to-cron
player_sync_schedule = "every 10 minutes"

[radio]
cgr_location = "./radio"

[external]
steam_key = "music_bokura_zutto_so_hype"
steam_realm = "http://localhost:1337"
steam_return_path = "/api/auth/return"
# all Sentry stuff is optional, refer to their docs to find out what these do
# if you plan on using Sentry, the DSN is required
# anything else not specified is set to the default
sentry_dsn = "https://somethingsomething@your.sentry.or.glitchtip/whatever"
sentry_logs = true
sentry_traces_sample_rate = 1.0
sentry_send_pii = true

Radio song list example (WavebreakerRadio.toml):

[[radio_songs]]
id = 1 # ID of the song on the server (song has to be known to the server already!)
title = "Dear Music." # Don't use non-ASCII characters
artist = "A4." # here too!
external_url = "https://www.youtube.com/watch?v=XeVrdjZSceA" # Put a link to buy (not stream!) the song here, if possible!
cgr_url = "http://localhost/as/asradio/WVBR_A4_DearMusic.cgr" # URL for the .cgr file containing the song,

To connect, use the latest Wavebreaker client with forceInsecure set to true in its config. This is only intended for local testing.

What works currently?

• Logging in/registering via Steam
• Leaderboards
• Automatically adding Steam friends as rivals
• Creating and retrieving songs from the DB
• Submitting scores
• Shouts (Song comments)
• Player rankings (using Skill Points)
• Audiosurf Radio! (using Rainbow Dream to create the needed files)
• MusicBrainz integration! (fetches cover art and title)
• Proper dethrones and the Brutus achievement! (not present in TypeScript version)
• Custom aliases for songs' title/artist names (not present in TypeScript version)
• Non-game API for frontends/other applications to use (There's an OpenAPI spec, too!)
• Miscellaneous stuff (e.g. custom news)

What still needs to be done?

• Song and user search API

Contributing

See CONTRIBUTING.md.