Go to file

allcontributors[bot] aa5592917d docs(contributors): add kyiuu1 as a contributor for ideas (#69 )

* docs: update README.md

* docs: update README.en.md

* docs: update .all-contributorsrc

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

2025-11-08 20:56:52 +08:00

.devcontainer

refactor(signalr): remove SignalR server & msgpack_lazer_api

2025-10-03 13:20:12 +00:00

.github

chore(deps): bump docker/build-push-action from 5 to 6 (#72 )

2025-11-02 10:19:59 +08:00

.vscode

chore(dev): update develop environment

2025-07-26 15:03:56 +00:00

app

feat(statistics): store ranked_score & total_score under classic scoring mode (#68 )

2025-11-08 20:56:29 +08:00

config

feat(mods): configure ranked mods by file (#49 )

2025-09-30 20:47:04 +08:00

migrations

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

nginx

chore(dev): update dev environment

2025-08-26 13:18:11 +08:00

scripts

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

static

chore(custom-ruleset): update custom ruleset definitions (#79 )

2025-11-08 19:33:57 +08:00

tools

feat(statistics): store ranked_score & total_score under classic scoring mode (#68 )

2025-11-08 20:56:29 +08:00

.all-contributorsrc

docs(contributors): add kyiuu1 as a contributor for ideas (#69 )

2025-11-08 20:56:52 +08:00

.dockerignore

feat(storage): expose a path to access local storage

2025-08-12 05:23:16 +00:00

.editorconfig

chore(dev): update dev environment

2025-08-26 13:18:11 +08:00

.env.example

Update .env.example

2025-10-12 02:52:22 +08:00

.gitignore

Add MailerSend and template-based email verification

2025-10-12 00:36:47 +08:00

.pre-commit-config.yaml

chore(pre-commit): update branch name

2025-11-08 16:50:18 +08:00

AGENTS.md

docs(dev): add guides for authorization

2025-10-04 07:49:35 +00:00

alembic.ini

refactor(database): rename migrations to make them more clear

2025-09-14 05:56:01 +00:00

CONTRIBUTING.md

docs(all-contributors): add initial contributors list

2025-10-19 18:29:11 +08:00

docker-compose-osurx.yml

deploy(docker): update spectator image to support custom rulesets

2025-10-26 13:14:53 +00:00

docker-compose.yml

deploy(docker): update spectator image to support custom rulesets

2025-10-26 13:14:53 +00:00

docker-entrypoint.sh

Improve JWT claims and chat channel reliability

2025-08-26 13:18:11 +08:00

Dockerfile

fix(ci): remove copy packages directory

2025-10-04 08:38:52 +00:00

Dockerfile-osurx

fix(ci): remove copy packages directory

2025-10-04 08:38:52 +00:00

LICENSE

更换许可

2025-09-17 01:01:33 +08:00

main.py

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

osu_lazer_api.code-workspace

refactor(signalr): remove SignalR server & msgpack_lazer_api

2025-10-03 13:20:12 +00:00

pyproject.toml

feat(calculator): support generate PerformanceAttributes & DifficultyAttributes from JSON Schema (#59 )

2025-10-25 19:10:53 +08:00

README.en.md

docs(contributors): add kyiuu1 as a contributor for ideas (#69 )

2025-11-08 20:56:52 +08:00

README.md

docs(contributors): add kyiuu1 as a contributor for ideas (#69 )

2025-11-08 20:56:52 +08:00

uv.lock

chore(deps): bump the minor-and-patch group with 13 updates (#73 )

2025-11-02 10:18:49 +08:00

README.en.md

g0v0-server

简体中文 | English

This is an osu! API server implemented with FastAPI + MySQL + Redis, supporting most features of osu! API v1, v2, and osu!lazer.

Features

OAuth 2.0 Authentication: Supports password and refresh token flows.
User Data Management: Complete user information, statistics, achievements, etc.
Multi-game Mode Support: osu! (RX, AP), taiko (RX), catch (RX), mania and custom rulesets (see below).
Database Persistence: MySQL for storing user data.
Cache Support: Redis for caching tokens and session information.
Multiple Storage Backends: Supports local storage, Cloudflare R2, and AWS S3.
Containerized Deployment: Docker and Docker Compose support.

Supported Rulesets

Ruleset	ID	ShortName	PP Algorithm (rosu)	PP Algorithm (performance-server)
osu!	`0`	`osu`	✅	✅
osu!taiko	`1`	`taiko`	✅	✅
osu!catch	`2`	`fruits`	✅	✅
osu!mania	`3`	`mania`	✅	✅
osu! (RX)	`4`	`osurx`	✅	✅
osu! (AP)	`5`	`osuap`	✅	✅
osu!taiko (RX)	`6`	`taikorx`	✅	✅
osu!catch (RX)	`7`	`fruitsrx`	✅	✅
Sentakki	`10`	`Sentakki`	❌	❌
tau	`11`	`tau`	❌	✅
Rush!	`12`	`rush`	❌	❌
hishigata	`13`	`hishigata`	❌	❌
soyokaze!	`14`	`soyokaze`	❌	✅

Go to custom-rulesets to download the custom rulesets modified for g0v0-server.

Quick Start

Using Docker Compose (Recommended)

Clone the project

git clone https://github.com/GooGuTeam/g0v0-server.git
cd g0v0-server

Create a .env file

Please see wiki to modify the .env file.
```
cp .env.example .env
```

Start the service

# Standard server
docker-compose -f docker-compose.yml up -d
# Enable osu!RX and osu!AP statistics (Gu pp algorithm based on ppy-sb pp algorithm)
docker-compose -f docker-compose-osurx.yml up -d

Connect to the server from the game

Use a custom osu!lazer client, or use LazerAuthlibInjection, and change the server settings to the server's address.

Updating the Database

Refer to the Database Migration Guide

Security

Use openssl rand -hex 32 to generate the JWT secret key to ensure the security of the server and the normal operation of the observer server.

Use openssl rand -hex 40 to generate the frontend secret key.

If it is in a public network environment, please block external requests to the /_lio path.

Documentation

Visit the wiki for more information.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only).
Any derivative work, modification, or deployment MUST clearly and prominently attribute the original authors:
GooGuTeam - https://github.com/GooGuTeam/g0v0-server